|
| | FabSetT () noexcept=default |
| | The default constructor – you must later call define().
|
| | FabSetT (const BoxArray &grids, const DistributionMapping &dmap, int ncomp) |
| | Construct a FabSetT<MF> covering grids with mapping dmap and ncomp components.
|
| | ~FabSetT ()=default |
| | FabSetT (FabSetT< MF > &&rhs) noexcept=default |
| | FabSetT (const FabSetT< MF > &rhs)=delete |
| FabSetT< MF > & | operator= (const FabSetT< MF > &rhs)=delete |
| FabSetT< MF > & | operator= (FabSetT< MF > &&rhs)=delete |
| void | define (const BoxArray &grids, const DistributionMapping &dmap, int ncomp) |
| | Define a FabSetT<MF> constructed via default constructor on grids/dmap with ncomp components.
|
| FAB const & | operator[] (const MFIter &mfi) const noexcept |
| | Access the FAB referenced by iterator mfi (const).
|
| FAB & | operator[] (const MFIter &mfi) noexcept |
| | Access the FAB referenced by iterator mfi (mutable).
|
| FAB const & | operator[] (int i) const noexcept |
| | Access the FAB with index i (const).
|
| FAB & | operator[] (int i) noexcept |
| | Access the FAB with index i (mutable).
|
| Array4< value_type const > | array (const MFIter &mfi) const noexcept |
| | Return an Array4 view for iterator mfi (const).
|
| Array4< value_type > | array (const MFIter &mfi) noexcept |
| | Return an Array4 view for iterator mfi (mutable).
|
| Array4< value_type const > | array (int i) const noexcept |
| | Return an Array4 view for FAB index i (const).
|
| Array4< value_type > | array (int i) noexcept |
| | Return an Array4 view for FAB index i (mutable).
|
| Array4< value_type const > | const_array (const MFIter &mfi) const noexcept |
| | Return a const Array4 view for iterator mfi.
|
| Array4< value_type const > | const_array (int i) const noexcept |
| | Return a const Array4 view for FAB index i.
|
| MultiArray4< value_type const > | arrays () const noexcept |
| | Return multi-fab const Array4 views to every FAB.
|
| MultiArray4< value_type > | arrays () noexcept |
| | Return multi-fab mutable Array4 views to every FAB.
|
| MultiArray4< value_type const > | const_arrays () const noexcept |
| | Return multi-fab const Array4 views (alias of arrays()).
|
| Box | fabbox (int K) const noexcept |
| | Get the bounding Box of FAB index K.
|
| int | size () const noexcept |
| | Return number of FABs stored in this set.
|
| const BoxArray & | boxArray () const noexcept |
| | Return the BoxArray defining FAB locations.
|
| const DistributionMapping & | DistributionMap () const noexcept |
| | Return the DistributionMapping describing FAB ownership.
|
| MF & | multiFab () noexcept |
| | Mutable access to the underlying MultiFab.
|
| MF const & | multiFab () const noexcept |
| | Const access to the underlying MultiFab.
|
| int | nComp () const noexcept |
| | Number of components carried by each FAB.
|
| void | clear () |
| | Release storage and reset the internal MultiFab.
|
| FabSetT< MF > & | copyFrom (const FabSetT< MF > &src, int scomp, int dcomp, int ncomp) |
| | Copy components from another FabSet with identical layout.
|
| FabSetT< MF > & | copyFrom (const MF &src, int ngrow, int scomp, int dcomp, int ncomp, const Periodicity &period=Periodicity::NonPeriodic()) |
| | Copy boundary data from a MultiFab intersecting the same boxes.
|
| FabSetT< MF > & | plusFrom (const FabSetT< MF > &src, int scomp, int dcomp, int ncomp) |
| | Accumulate data from another FabSet with identical layout.
|
| FabSetT< MF > & | plusFrom (const MF &src, int ngrow, int scomp, int dcomp, int ncomp, const Periodicity &period=Periodicity::NonPeriodic(), bool deterministic=false) |
| | Accumulate data from a MultiFab into this boundary set.
|
| void | copyTo (MF &dest, int ngrow, int scomp, int dcomp, int ncomp, const Periodicity &period=Periodicity::NonPeriodic()) const |
| | Copy data from this boundary set back into a MultiFab.
|
| void | plusTo (MF &dest, int ngrow, int scomp, int dcomp, int ncomp, const Periodicity &period=Periodicity::NonPeriodic()) const |
| | Add this boundary data back into a MultiFab.
|
| void | setVal (value_type val) |
| | Fill every component of every FAB with scalar value val.
|
| void | setVal (value_type val, int comp, int num_comp) |
| | Fill num_comp components starting at comp with scalar value val.
|
| FabSetT< MF > & | linComb (value_type a, value_type b, const FabSetT< MF > &src, int scomp, int dcomp, int ncomp) |
| | Linear combination: this := a*this + b*src.
|
| FabSetT< MF > & | linComb (value_type a, const MF &mfa, int a_comp, value_type b, const MF &mfb, int b_comp, int dcomp, int ncomp, int ngrow) |
| | Boundary linear combination from two MultiFabs: this := a*mfa + b*mfb.
|
| void | write (const std::string &name) const |
| | Write (used for writing to checkpoint).
|
| void | read (const std::string &name) |
| | Read (used for reading from checkpoint).
|
template<typename MF>
class amrex::FabSetT< MF >
A FabSet is a group of FArrayBox's. The grouping is designed specifically to represent regions along the boundary of Box's, and are used to implement boundary conditions to discretized partial differential equations.
A FabSet is an array of pointers to FABs. The standard FAB operators, however, have been modified to be more useful for maintaining boundary conditions for partial differential equations discretized on boxes. Under normal circumstances, a FAB will be created for each face of a box. For a group of boxes, a FabSet will be the group of FABs at a particular orientation (ie. the lo-i side of each grid in a list).
Since a FabSet FAB will likely be used to bound a grid box, FArrayBox::resize() operations are disallowed. Also, to preserve flexibility in applicable boundary scenarios, intersecting FABs in the FabSet are not guaranteed to contain identical data–thus copy operations from a FabSet to any FAB-like structure may be order-dependent.
FabSets are used primarily as a data storage mechanism, and are manipulated by more sophisticated control classes.
1.15.0