Chombo + EB  3.2
Classes | Public Member Functions | Protected Attributes | Private Member Functions | List of all members
IrregFAB Class Reference

#include <IrregFAB.H>

Inheritance diagram for IrregFAB:
Inheritance graph
[legend]

Classes

class  additionOp
 operator for += More...
 
class  arithOp
 some stuff to do arithmetic More...
 
class  divisionOp
 operator for /= More...
 
class  multiplicationOp
 operator for *= More...
 
class  subtractionOp
 operator for -= More...
 

Public Member Functions

 IrregFAB ()
 
 IrregFAB (const Box &a_region, const EBGraph &a_ebgraph, const int &a_nvarin)
 
virtual ~IrregFAB ()
 
virtual void define (const Box &a_region, const EBGraph &a_ebgraph, const int &a_nvarin)
 
 IrregFAB (const Box &a_region, int a_nVar)
 invalid but necessary for leveldata to compile More...
 
IrregFABapplyOp (const Real &a_srcVal, int a_srccomp, int a_destcomp, int a_numcomp, IrregFAB::arithOp &a_op)
 apply any operator pointwise for two fabs. More...
 
IrregFABapplyOp (const IrregFAB &a_srcVal, const Box &a_region, int a_srccomp, int a_destcomp, int a_numcomp, IrregFAB::arithOp &a_op)
 apply any operator pointwise with input real number More...
 
IrregFABoperator+= (const IrregFAB &a_ebfab)
 
IrregFABoperator+= (const Real &a_ebfab)
 
IrregFABoperator-= (const IrregFAB &a_ebfab)
 
IrregFABoperator-= (const Real &a_ebfab)
 
IrregFABoperator*= (const IrregFAB &a_IrregFAB)
 
IrregFABoperator*= (const Real &a_ebfab)
 
IrregFABoperator/= (const IrregFAB &a_ebfab)
 
IrregFABoperator/= (const Real &a_ebfab)
 
IrregFABplus (const IrregFAB &a_src, int a_srccomp, int a_destcomp, int a_numcomp)
 more flexible versions of stuff More...
 
IrregFABplus (const Real &a_src, int a_srccomp, int a_destcomp, int a_numcomp)
 
IrregFABplus (const IrregFAB &a_src, const Box &a_region, int a_srccomp, int a_destcomp, int a_numcomp)
 
IrregFABminus (const IrregFAB &a_src, int a_srccomp, int a_destcomp, int a_numcomp)
 
IrregFABminus (const Real &a_src, int a_srccomp, int a_destcomp, int a_numcomp)
 
IrregFABmult (const Real &a_src, int a_srccomp, int a_destcomp, int a_numcomp)
 
IrregFABdivide (const Real &a_src, int a_srccomp, int a_destcomp, int a_numcomp)
 
IrregFABminus (const IrregFAB &a_src, const Box &a_region, int a_srccomp, int a_destcomp, int a_numcomp)
 
IrregFABmult (const IrregFAB &a_src, int a_srccomp, int a_destcomp, int a_numcomp)
 
IrregFABmult (const IrregFAB &a_src, const Box &a_region, int a_srccomp, int a_destcomp, int a_numcomp)
 
IrregFABdivide (const IrregFAB &a_src, int a_srccomp, int a_destcomp, int a_numcomp)
 
IrregFABdivide (const IrregFAB &a_src, const Box &a_region, int a_srccomp, int a_destcomp, int a_numcomp)
 
- Public Member Functions inherited from BaseIVFAB< Real >
 BaseIVFAB ()
 
 BaseIVFAB (const IntVectSet &a_region, const EBGraph &a_ebgraph, const int &a_nvarin)
 
 BaseIVFAB (const Interval &a_comps, BaseIVFAB< Real > &a_original)
 
 BaseIVFAB (const Box &a_region, int a_nVar)
 invalid but necessary for leveldata to compile More...
 
int numDataTypes () const
 for AggStencil More...
 
int dataType (const BaseIndex &a_baseInd) const
 for AggStencil More...
 
RealdataPtr (int a_dataType, int a_ivar)
 
const RealdataPtr (int a_dataType, int a_ivar) const
 
RealdataPtr (const int &a_comp)
 
const RealdataPtr (const int &a_comp) const
 
virtual ~BaseIVFAB ()
 
virtual void define (const IntVectSet &a_region, const EBGraph &a_ebgraph, const int &a_nvarin)
 
void setVal (const Real &value)
 
void setVal (int ivar, const Real &value)
 
void setVal (const Real &a_value, const Box &a_box, int a_nstart, int a_numcomp)
 
void copy (const Box &a_fromBox, const Interval &a_destInterval, const Box &a_toBox, const BaseIVFAB< Real > &a_src, const Interval &a_srcInterval)
 
int size (const Box &R, const Interval &comps) const
 
void linearOut (void *buf, const Box &R, const Interval &comps) const
 
void linearIn (void *buf, const Box &R, const Interval &comps)
 
virtual void clear ()
 
bool isDefined () const
 
int numVoFs () const
 
int nComp () const
 
const IntVectSetgetIVS () const
 
const EBGraphgetEBGraph () const
 
Realoperator() (const VolIndex &a_vof, const int &varlocin)
 
const Realoperator() (const VolIndex &a_vof, const int &varlocin) const
 
virtual RealgetIndex (const VolIndex &a_vof, const int &a_comp) const
 get index into vector More...
 
long offset (const BaseIndex &a_vof, const int &a_ivar) const
 for AggStencil More...
 

Protected Attributes

Box m_region
 
- Protected Attributes inherited from BaseIVFAB< Real >
Vector< Realm_data
 
int m_nComp
 
int m_nVoFs
 
EBGraph m_ebgraph
 
BaseFab< Real *> m_fab
 
IntVectSet m_ivs
 
bool m_isDefined
 

Private Member Functions

void operator= (const IrregFAB &a_input)
 
 IrregFAB (const IrregFAB &a_input)
 

Additional Inherited Members

- Static Public Member Functions inherited from BaseIVFAB< Real >
static int preAllocatable ()
 
static void setVerbose (bool a_verbose)
 
static void setVerboseDebug (bool a_verboseDebug)
 
- Static Public Attributes inherited from BaseIVFAB< Real >
static bool s_verboseDebug
 
- Protected Member Functions inherited from BaseIVFAB< Real >
virtual void setDefaultValues ()
 
- Static Protected Attributes inherited from BaseIVFAB< Real >
static bool s_verbose
 

Detailed Description

This is a data holder which holds data over the irregular cells in a box.

Constructor & Destructor Documentation

◆ IrregFAB() [1/4]

IrregFAB::IrregFAB ( )

Default constructor. Constructs an uninitialized IVFAB. You must subsequently call { define} before using this IVFAB.

◆ IrregFAB() [2/4]

IrregFAB::IrregFAB ( const Box a_region,
const EBGraph a_ebgraph,
const int &  a_nvarin 
)

Defining constructor. Specifies the irregular domain as the irregular cells within the region and the number of data components per VoF. The irregular domain must lie completely within the EBGraph. The contents are uninitialized. Calls full define function.

◆ ~IrregFAB()

virtual IrregFAB::~IrregFAB ( )
virtual

◆ IrregFAB() [3/4]

IrregFAB::IrregFAB ( const Box a_region,
int  a_nVar 
)
inline

invalid but necessary for leveldata to compile

References MayDay::Error().

◆ IrregFAB() [4/4]

IrregFAB::IrregFAB ( const IrregFAB a_input)
inlineprivate

References MayDay::Error().

Member Function Documentation

◆ define()

virtual void IrregFAB::define ( const Box a_region,
const EBGraph a_ebgraph,
const int &  a_nvarin 
)
virtual

Full define function. Specifies the irregular domain as the irregular cells within the regionand the number of data components per VoF. The irregular domain must lie completely within the EBGraph. The contents are uninitialized. If it has previously been defined, the old definition data is overwritten and lost.

◆ applyOp() [1/2]

IrregFAB& IrregFAB::applyOp ( const Real a_srcVal,
int  a_srccomp,
int  a_destcomp,
int  a_numcomp,
IrregFAB::arithOp a_op 
)

apply any operator pointwise for two fabs.

Referenced by IrregFAB::divisionOp::func().

◆ applyOp() [2/2]

IrregFAB& IrregFAB::applyOp ( const IrregFAB a_srcVal,
const Box a_region,
int  a_srccomp,
int  a_destcomp,
int  a_numcomp,
IrregFAB::arithOp a_op 
)

apply any operator pointwise with input real number

◆ operator+=() [1/2]

IrregFAB& IrregFAB::operator+= ( const IrregFAB a_ebfab)

done over intersection of src, dst Both fabs need the same ncomp

Referenced by IrregFAB::divisionOp::func().

◆ operator+=() [2/2]

IrregFAB& IrregFAB::operator+= ( const Real a_ebfab)

done over intersection of src, dst Both fabs need the same ncomp

◆ operator-=() [1/2]

IrregFAB& IrregFAB::operator-= ( const IrregFAB a_ebfab)

done over intersection of src, dst Both fabs need the same ncomp

Referenced by IrregFAB::divisionOp::func().

◆ operator-=() [2/2]

IrregFAB& IrregFAB::operator-= ( const Real a_ebfab)

◆ operator*=() [1/2]

IrregFAB& IrregFAB::operator*= ( const IrregFAB a_IrregFAB)

done over intersection of src, dst Both fabs need the same ncomp

Referenced by IrregFAB::divisionOp::func().

◆ operator*=() [2/2]

IrregFAB& IrregFAB::operator*= ( const Real a_ebfab)

◆ operator/=() [1/2]

IrregFAB& IrregFAB::operator/= ( const IrregFAB a_ebfab)

done over intersection of src, dst Both fabs need the same ncomp

Referenced by IrregFAB::divisionOp::func().

◆ operator/=() [2/2]

IrregFAB& IrregFAB::operator/= ( const Real a_ebfab)

◆ plus() [1/3]

IrregFAB& IrregFAB::plus ( const IrregFAB a_src,
int  a_srccomp,
int  a_destcomp,
int  a_numcomp 
)

more flexible versions of stuff

Referenced by IrregFAB::divisionOp::func().

◆ plus() [2/3]

IrregFAB& IrregFAB::plus ( const Real a_src,
int  a_srccomp,
int  a_destcomp,
int  a_numcomp 
)

◆ plus() [3/3]

IrregFAB& IrregFAB::plus ( const IrregFAB a_src,
const Box a_region,
int  a_srccomp,
int  a_destcomp,
int  a_numcomp 
)

◆ minus() [1/3]

IrregFAB& IrregFAB::minus ( const IrregFAB a_src,
int  a_srccomp,
int  a_destcomp,
int  a_numcomp 
)

◆ minus() [2/3]

IrregFAB& IrregFAB::minus ( const Real a_src,
int  a_srccomp,
int  a_destcomp,
int  a_numcomp 
)

◆ mult() [1/3]

IrregFAB& IrregFAB::mult ( const Real a_src,
int  a_srccomp,
int  a_destcomp,
int  a_numcomp 
)

◆ divide() [1/3]

IrregFAB& IrregFAB::divide ( const Real a_src,
int  a_srccomp,
int  a_destcomp,
int  a_numcomp 
)

◆ minus() [3/3]

IrregFAB& IrregFAB::minus ( const IrregFAB a_src,
const Box a_region,
int  a_srccomp,
int  a_destcomp,
int  a_numcomp 
)

◆ mult() [2/3]

IrregFAB& IrregFAB::mult ( const IrregFAB a_src,
int  a_srccomp,
int  a_destcomp,
int  a_numcomp 
)

◆ mult() [3/3]

IrregFAB& IrregFAB::mult ( const IrregFAB a_src,
const Box a_region,
int  a_srccomp,
int  a_destcomp,
int  a_numcomp 
)

◆ divide() [2/3]

IrregFAB& IrregFAB::divide ( const IrregFAB a_src,
int  a_srccomp,
int  a_destcomp,
int  a_numcomp 
)

◆ divide() [3/3]

IrregFAB& IrregFAB::divide ( const IrregFAB a_src,
const Box a_region,
int  a_srccomp,
int  a_destcomp,
int  a_numcomp 
)

◆ operator=()

void IrregFAB::operator= ( const IrregFAB a_input)
inlineprivate

References MayDay::Error().

Member Data Documentation

◆ m_region

Box IrregFAB::m_region
protected

The documentation for this class was generated from the following file: