Chombo + EB  3.2
TensorFunction Class Referenceabstract

#include <TensorFunction.H>

Inheritance diagram for TensorFunction:
[legend]

## Public Member Functions

TensorFunction (bool a_homogeneous, bool a_constant)

virtual ~TensorFunction ()
Destructor. More...

virtual RealTensor operator() (const RealVect &a_x, Real a_t) const =0

RealTensor operator() (const RealVect &a_x) const

bool isHomogeneous () const
Returns true if this function is homogeneous, false otherwise. More...

bool isConstant () const
Returns true if this function is constant, false otherwise. More...

## Protected Attributes

bool m_isHomogeneous

bool m_isConstant

## Private Member Functions

TensorFunction ()

TensorFunction (const TensorFunction &)

TensorFunctionoperator= (const TensorFunction &)

## Detailed Description

This base class represents a tensor function .

## ◆ TensorFunction() [1/3]

 TensorFunction::TensorFunction ( bool a_homogeneous, bool a_constant )

Base class constructor. Must be called by subclasses.

Parameters
 a_homogeneous This flag indicates whether the tensor function is constant in space. a_constant This flag indicates whether the tensor function is constant in time.

## ◆ ~TensorFunction()

 virtual TensorFunction::~TensorFunction ( )
virtual

Destructor.

## ◆ TensorFunction() [2/3]

 TensorFunction::TensorFunction ( )
private

## ◆ TensorFunction() [3/3]

 TensorFunction::TensorFunction ( const TensorFunction & )
private

## ◆ operator()() [1/2]

 virtual RealTensor TensorFunction::operator() ( const RealVect & a_x, Real a_t ) const
pure virtual

Override this method to evaluate this function at the given point in space and time.

Parameters
 a_x A point in -dimensional space. a_t The time at which the function is evaluated.

Implemented in ConstantTensorFunction.

Referenced by operator()().

## ◆ operator()() [2/2]

 RealTensor TensorFunction::operator() ( const RealVect & a_x ) const
inline

This evaluates the function at time 0.

Parameters
 a_x A point in -dimensional space.

References operator()().

## ◆ isHomogeneous()

 bool TensorFunction::isHomogeneous ( ) const
inline

Returns true if this function is homogeneous, false otherwise.

References m_isHomogeneous.

## ◆ isConstant()

 bool TensorFunction::isConstant ( ) const
inline

Returns true if this function is constant, false otherwise.

References m_isConstant.

## ◆ operator=()

 TensorFunction& TensorFunction::operator= ( const TensorFunction & )
private

## ◆ m_isHomogeneous

 bool TensorFunction::m_isHomogeneous
protected

Referenced by isHomogeneous().

## ◆ m_isConstant

 bool TensorFunction::m_isConstant
protected

Referenced by isConstant().

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