TensorFunction Class Reference

#include <TensorFunction.H>

Inheritance diagram for TensorFunction:

Inheritance graph
[legend]

List of all members.


Detailed Description

This base class represents a tensor function $T: \mathbf{R}^D \rightarrow \mathbf{R}^D\otimes\mathbf{R}^D$.

Public Member Functions

 TensorFunction (bool a_homogeneous, bool a_constant)
virtual ~TensorFunction ()
 Destructor.
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.
bool isConstant () const
 Returns true if this function is constant, false otherwise.

Protected Attributes

bool m_isHomogeneous
bool m_isConstant

Private Member Functions

 TensorFunction ()
 TensorFunction (const TensorFunction &)
TensorFunctionoperator= (const TensorFunction &)

Constructor & Destructor Documentation

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.

virtual TensorFunction::~TensorFunction (  )  [virtual]

Destructor.

TensorFunction::TensorFunction (  )  [private]

TensorFunction::TensorFunction ( const TensorFunction  )  [private]


Member Function Documentation

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 $D$-dimensional space.
a_t The time at which the function is evaluated.

Implemented in ConstantTensorFunction.

Referenced by operator()().

RealTensor TensorFunction::operator() ( const RealVect a_x  )  const [inline]

This evaluates the function at time 0.

Parameters:
a_x A point in $D$-dimensional space.

References operator()().

bool TensorFunction::isHomogeneous (  )  const [inline]

Returns true if this function is homogeneous, false otherwise.

References m_isHomogeneous.

bool TensorFunction::isConstant (  )  const [inline]

Returns true if this function is constant, false otherwise.

References m_isConstant.

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


Member Data Documentation

Referenced by isHomogeneous().

bool TensorFunction::m_isConstant [protected]

Referenced by isConstant().


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

Generated on Fri Dec 15 03:27:33 2017 for Chombo + EB + MF by  doxygen 1.5.5