/usr/include/BoxLib/MultiFab.H is in libbox-dev 2.5-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 | /*
** (c) 1996-2000 The Regents of the University of California (through
** E.O. Lawrence Berkeley National Laboratory), subject to approval by
** the U.S. Department of Energy. Your use of this software is under
** license -- the license agreement is attached and included in the
** directory as license.txt or you may contact Berkeley Lab's Technology
** Transfer Department at TTD@lbl.gov. NOTICE OF U.S. GOVERNMENT RIGHTS.
** The Software was developed under funding from the U.S. Government
** which consequently retains certain rights as follows: the
** U.S. Government has been granted for itself and others acting on its
** behalf a paid-up, nonexclusive, irrevocable, worldwide license in the
** Software to reproduce, prepare derivative works, and perform publicly
** and display publicly. Beginning five (5) years after the date
** permission to assert copyright is obtained from the U.S. Department of
** Energy, and subject to any subsequent five (5) year renewals, the
** U.S. Government is granted for itself and others acting on its behalf
** a paid-up, nonexclusive, irrevocable, worldwide license in the
** Software to reproduce, prepare derivative works, distribute copies to
** the public, perform publicly and display publicly, and to permit
** others to do so.
*/
#ifndef BL_MULTIFAB_H
#define BL_MULTIFAB_H
//
// $Id: MultiFab.H,v 1.43 2001/08/02 16:01:44 car Exp $
//
#include <winstd.H>
#include <BLassert.H>
#include <FArrayBox.H>
#include <FabArray.H>
//
// Forward declaration.
//
typedef FabArrayId MultiFabId;
class MultiFabCopyDescriptor;
class MultiFab;
namespace BoxLib
{
void linInterpAddBox (MultiFabCopyDescriptor& fabCopyDesc,
BoxList* returnUnfilledBoxes,
Array<FillBoxId>& returnedFillBoxIds,
const Box& subbox,
const MultiFabId& faid1,
const MultiFabId& faid2,
Real t1,
Real t2,
Real t,
int src_comp,
int dest_comp,
int num_comp,
bool extrap);
void linInterpFillFab (MultiFabCopyDescriptor& fabCopyDesc,
const Array<FillBoxId>& fillBoxIds,
const MultiFabId& faid1,
const MultiFabId& faid2,
FArrayBox& dest,
Real t1,
Real t2,
Real t,
int src_comp,
int dest_comp,
int num_comp,
bool extrap);
}
//
//@Man:
//@Memo: A Collection of FArrayBoxes
/*@Doc:
The MultiFab class is publically derived from the
FabArray<Real,FArrayBox> class. It is a collection (stored as an array) of
FArrayBoxes useful for storing floating point data on a domain defined by
a union of rectangular regions embedded in a uniform index space. The
MultiFab class extends the function of the underlying FabArray class just
as the FArrayBox class extends the funtion of BaseFab<Real>. Additional
member functions are defined for I/O and simple arithmetic operations on
these aggregate objects.
This class does NOT provide a copy constructor or assignment operator.
*/
class MultiFab
:
public FabArray<FArrayBox>
{
public:
/*@ManDoc: Constructs an empty MultiFab. Data can be defined at a later
time using the `define' member functions inherited
from FabArray.
*/
MultiFab ();
/*@ManDoc: Constructs a MultiFab with a valid region defined by bxs and
a region of definition defined by the grow factor ngrow.
If mem\_mode is defined to be Fab\_allocate then FArrayBoxes are
allocated for each Box in the BoxArray. The size of the
FArrayBox is given by the Box grown by ngrow and the number of
components is given by ncomp. If mem\_mode is defined to be
Fab\_noallocate then no FArrayBoxes are allocated at this time
but can be defined later.
*/
MultiFab (const BoxArray& bs,
int ncomp,
int ngrow,
FabAlloc mem_mode = Fab_allocate);
void operator= (const Real& r);
/*@ManDoc: Returns the minimum value contained in component comp of the
MultiFab. The parameter nghost determines the number of
boundary cells to search for the minimum. The default is to
search only the valid regions of the FArrayBoxes.
*/
Real min (int comp,
int nghost = 0) const;
/*@ManDoc: Identical to the previous min() function, but confines its
search to intersection of Box b and the MultiFab.
*/
Real min (const Box& b,
int comp,
int nghost = 0) const;
/*@ManDoc: Returns the maximum value contained in component comp of the
MultiFab. The parameter nghost determines the number of
boundary cells to search for the maximum. The default is to
search only the valid regions of the FArrayBoxes.
*/
Real max (int comp,
int nghost = 0) const;
/*@ManDoc: Identical to the previous max() function, but confines its
search to intersection of Box b and the MultiFab.
*/
Real max (const Box& b,
int comp,
int nghost = 0) const;
/*@ManDoc: Adds the scalar value val to the value of each cell in the
specified subregion of the MultiFab. The subregion consists
of the num\_comp components starting at component comp.
The value of nghost specifies the number of cells in the
boundary region of each FArrayBox in the subregion that should
be modified.
*/
void plus (Real val,
int comp,
int num_comp,
int nghost = 0);
/*@ManDoc: Identical to the previous version of plus(), with the
restriction that the subregion is further constrained to
the intersection with Box region.
*/
void plus (Real val,
const Box& region,
int comp,
int num_comp,
int nghost = 0);
/*@ManDoc: Adds the scalar value val to the value of each cell in the
valid region of each component of the MultiFab. The value
of nghost specifies the number of cells in the boundary
region that should be modified.
*/
void plus (Real val,
int nghost);
/*@ManDoc: Adds the scalar value val to the value of each cell in the
valid region of each component of the MultiFab, that also
intersects the Box region. The value of nghost specifies the
number of cells in the boundary region of each FArrayBox in
the subregion that should be modified.
*/
void plus (Real val,
const Box& region,
int nghost);
/*@ManDoc: Scales the value of each cell in the specified subregion of the
MultiFab by the scalar val (a[i] <- a[i]*val). The subregion
consists of the num\_comp components starting at component comp.
The value of nghost specifies the number of cells in the
boundary region of each FArrayBox in the subregion that should
be modified.
*/
void mult (Real val,
int comp,
int num_comp,
int nghost = 0);
/*@ManDoc: Identical to the previous version of mult(), with the
restriction that the subregion is further constrained to the
intersection with Box region. The value of nghost specifies the
number of cells in the boundary region of each FArrayBox in
the subregion that should be modified.
*/
void mult (Real val,
const Box& region,
int comp,
int num_comp,
int nghost = 0);
/*@ManDoc: Scales the value of each cell in the valid region of each
component of the MultiFab by the scalar val (a[i] <- a[i]*val).
The value of nghost specifies the number of cells in the
boundary region that should be modified.
*/
void mult (Real val,
int nghost = 0);
/*@ManDoc: Scales the value of each cell in the valid region of each
component of the MultiFab by the scalar val (a[i] <- a[i]*val),
that also intersects the Box region. The value of nghost
specifies the number of cells in the boundary region of each
FArrayBox in the subregion that should be modified.
*/
void mult (Real val,
const Box& region,
int nghost = 0);
/*@ManDoc: Replaces the value of each cell in the specified subregion of
the MultiFab with its reciprocal multiplied by the value of
numerator. The subregion consists of the num\_comp components
starting at component comp. The value of nghost specifies the
number of cells in the boundary region of each FArrayBox in the
subregion that should be modified.
*/
void invert (Real numerator,
int comp,
int num_comp,
int nghost = 0);
/*@ManDoc: Identical to the previous version of invert(), with the
restriction that the subregion is further constrained to the
intersection with Box region. The value of nghost specifies the
number of cells in the boundary region of each FArrayBox in the
subregion that should be modified.
*/
void invert (Real numerator,
const Box& region,
int comp,
int num_comp,
int nghost = 0);
/*@ManDoc: Replaces the value of each cell in the specified subregion of
the MultiFab with its reciprocal multiplied by the value of
numerator. The value of nghost specifies the number of cells
in the boundary region that should be modified.
*/
void invert (Real numerator,
int nghost);
/*@ManDoc: Replaces the value of each cell in the specified subregion of
the MultiFab, that also intersects the Box region, with its
reciprocal multiplied by the value of numerator. The value
of nghost specifies the number of cells in the boundary region
of each FArrayBox in the subregion that should be modified.
*/
void invert (Real numerator,
const Box& region,
int nghost);
/*@ManDoc: Negates the value of each cell in the specified subregion of
the MultiFab. The subregion consists of the num\_comp
components starting at component comp. The value of nghost
specifies the number of cells in the boundary region of each
FArrayBox in the subregion that should be modified.
*/
void negate (int comp,
int num_comp,
int nghost = 0);
/*@ManDoc: Identical to the previous version of negate(), with the
restriction that the subregion is further constrained to
the intersection with Box region.
*/
void negate (const Box& region,
int comp,
int num_comp,
int nghost = 0);
/*@ManDoc: Negates the value of each cell in the valid region of
the MultiFab. The value of nghost specifies the number of
cells in the boundary region that should be modified.
*/
void negate (int nghost = 0);
/*@ManDoc: Negates the value of each cell in the valid region of
the MultiFab that also intersects the Box region. The value
of nghost specifies the number of cells in the boundary region
that should be modified.
*/
void negate (const Box& region,
int nghost = 0);
/*@ManDoc:
This function adds the values of the cells in mf to the corresponding
cells of this MultiFab. mf is required to have the same BoxArray or
"valid region" as this MultiFab. The addition is done only to num\_comp
components, starting with component number strt\_comp. The parameter
nghost specifies the number of boundary cells that will be modified.
If nghost == 0, only the valid region of each FArrayBox will be
modified.
*/
void plus (const MultiFab& mf,
int strt_comp,
int num_comp,
int nghost);
/*@ManDoc:
This function subtracts the values of the cells in mf from the
corresponding cells of this MultiFab. mf is required to have the
same BoxArray or "valid region" as this MultiFab. The subtraction is
done only to num\_comp components, starting with component number
strt\_comp. The parameter nghost specifies the number of boundary
cells that will be modified. If nghost == 0, only the valid region of
each FArrayBox will be modified.
*/
void minus (const MultiFab& mf,
int strt_comp,
int num_comp,
int nghost);
/*@ManDoc: Copy on intersection within MultiFab. Data is copied from
valid regions to intersecting regions of definition. The
purpose is to fill in the boundary regions of each FAB in
the MultiFab.
*/
void FillBoundary ();
/*@ManDoc: Same as FillBoundary(), but only copies
num\_comp components starting at src\_comp.
*/
void FillBoundary (int src_comp,
int num_comp);
//
//@ManDoc: Flush the cache of self-intersection info used by FillBoundary.
//
static void FlushSICache ();
//
//@ManDoc: The size of the cache of self-intersection info.
//
static int SICacheSize ();
/*@ManDoc: Copy from `src' to `dst' including `nghost' ghost cells.
The two MultiFabs MUST have the same underlying BoxArray.
*/
static void Copy (MultiFab& dst,
const MultiFab& src,
int srccomp,
int dstcomp,
int numcomp,
int nghost);
private:
//
// These are disabled.
//
MultiFab (const MultiFab& rhs);
MultiFab& operator= (const MultiFab& rhs);
};
class MultiFabCopyDescriptor
:
public FabArrayCopyDescriptor<FArrayBox>
{
public:
MultiFabCopyDescriptor ()
:
FabArrayCopyDescriptor<FArrayBox>() {}
MultiFabId RegisterMultiFab (MultiFab* mf)
{
return RegisterFabArray(mf);
}
private:
//
// These are disallowed.
//
MultiFabCopyDescriptor (const MultiFabCopyDescriptor&);
MultiFabCopyDescriptor& operator= (const MultiFabCopyDescriptor&);
};
#endif /*BL_MULTIFAB_H*/
|