Chombo + EB  3.0
Public Member Functions | Protected Attributes | Private Member Functions | List of all members
SumIF Class Reference

#include <SumIF.H>

Inheritance diagram for SumIF:
Inheritance graph
[legend]

Public Member Functions

 SumIF (const BaseIF &a_impFunc1, const BaseIF &a_impFunc2, const bool &a_sign)
 
 SumIF (const Vector< BaseIF *> &a_impFuncs)
 
 SumIF (const SumIF &a_inputIF)
 Copy constructor. More...
 
virtual ~SumIF ()
 Destructor. More...
 
void setSign (bool a_sign)
 
virtual Real value (const RealVect &a_point) const
 
virtual Real value (const IndexTM< Real, GLOBALDIM > &a_point) const
 
virtual Real value (const IndexTM< int, GLOBALDIM > &a_partialDerivative, const IndexTM< Real, GLOBALDIM > &a_point) const
 
virtual bool getSign () const
 
virtual BaseIFgetImplicitFunction (int a_num)
 
virtual BaseIFnewImplicitFunction () const
 
virtual void boxLayoutChanged (const DisjointBoxLayout &a_newBoxLayout, const RealVect &a_dx)
 
- Public Member Functions inherited from BaseIF
 BaseIF ()
 Default constructor. More...
 
virtual ~BaseIF ()
 Default destructor. More...
 
virtual bool fastIntersection (const Box &a_region, const ProblemDomain &a_domain, const RealVect &a_origin, const Real &a_dx) const
 
virtual bool fastIntersection (const RealVect &a_low, const RealVect &a_high) const
 
virtual GeometryService::InOut InsideOutside (const Box &a_region, const ProblemDomain &a_domain, const RealVect &a_origin, const Real &a_dx) const
 
virtual GeometryService::InOut InsideOutside (const RealVect &a_low, const RealVect &a_high) const
 
virtual void print (ostream &out) const
 

Protected Attributes

int m_numFuncs
 
Vector< BaseIF * > m_impFuncs
 
bool m_sign
 

Private Member Functions

 SumIF ()
 
void operator= (const SumIF &a_inputIF)
 

Additional Inherited Members

- Static Public Member Functions inherited from BaseIF
static void corners (const Box &a_region, const RealVect &a_origin, const Real &a_dx, RealVect &a_lo, RealVect &a_hi)
 

Detailed Description

This implicit function is the sum of two (of more) implicit functions with which it is constructed.

Constructor & Destructor Documentation

◆ SumIF() [1/4]

SumIF::SumIF ( const BaseIF a_impFunc1,
const BaseIF a_impFunc2,
const bool &  a_sign 
)

Constructor specifying two implicit functions as inputs.

◆ SumIF() [2/4]

SumIF::SumIF ( const Vector< BaseIF *> &  a_impFuncs)

Constructor specifying any number of implicit functions as inputs.

◆ SumIF() [3/4]

SumIF::SumIF ( const SumIF a_inputIF)

Copy constructor.

◆ ~SumIF()

virtual SumIF::~SumIF ( )
virtual

Destructor.

◆ SumIF() [4/4]

SumIF::SumIF ( )
inlineprivate

References MayDay::Abort().

Member Function Documentation

◆ setSign()

void SumIF::setSign ( bool  a_sign)

◆ value() [1/3]

virtual Real SumIF::value ( const RealVect a_point) const
virtual

Return the value of the function at a_point.

Implements BaseIF.

◆ value() [2/3]

virtual Real SumIF::value ( const IndexTM< Real, GLOBALDIM > &  a_point) const
virtual

Return the value of the function at a_point (of type INdexTM).

Reimplemented from BaseIF.

◆ value() [3/3]

virtual Real SumIF::value ( const IndexTM< int, GLOBALDIM > &  a_partialDerivative,
const IndexTM< Real, GLOBALDIM > &  a_point 
) const
virtual

Reimplemented from BaseIF.

◆ getSign()

virtual bool SumIF::getSign ( ) const
virtual

◆ getImplicitFunction()

virtual BaseIF* SumIF::getImplicitFunction ( int  a_num)
virtual

◆ newImplicitFunction()

virtual BaseIF* SumIF::newImplicitFunction ( ) const
virtual

Return a newly allocated derived class. The responsibility for deleting the memory is left to the calling function.

Implements BaseIF.

◆ boxLayoutChanged()

virtual void SumIF::boxLayoutChanged ( const DisjointBoxLayout a_newBoxLayout,
const RealVect a_dx 
)
inlinevirtual

Pass this call onto the IFs contained in this IF class.

Reimplemented from BaseIF.

References m_impFuncs, and m_numFuncs.

◆ operator=()

void SumIF::operator= ( const SumIF a_inputIF)
inlineprivate

References MayDay::Abort().

Member Data Documentation

◆ m_numFuncs

int SumIF::m_numFuncs
protected

Referenced by boxLayoutChanged().

◆ m_impFuncs

Vector<BaseIF*> SumIF::m_impFuncs
protected

Referenced by boxLayoutChanged().

◆ m_sign

bool SumIF::m_sign
protected

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