Main Page | User's guide | Class Hierarchy | Class List | File List | Class Members

Multivac::CSpeedFunction< T > Class Template Reference

Base class for speed functions. More...

#include <baseclass.hxx>

Inheritance diagram for Multivac::CSpeedFunction< T >:

Multivac::CConstantSpeed< T > Multivac::CFireModel< T > Multivac::CPiecewiseConstantSpeed< T > Multivac::CSimplifiedFireModel< T > List of all members.

Public Member Functions

 CSpeedFunction () throw ()
 Default constructor.

virtual ~CSpeedFunction () throw ()
 Destructor.

bool IsPositionDependent () const
 Does the speed function depend upon the position?

bool IsTimeDependent () const
 Does the speed function depend upon the time?

bool IsNormalDependent () const
 Does the speed function depend upon the normal?

bool IsCurvatureDependent () const
 Does the speed function depend upon the curvature?

virtual void Init (CMesh< T > &Mesh)=0
Matrix< T > & GetValues ()
 Returns the matrix that stores speed rates on grid points.

virtual T operator() (T x, T y, T time) const=0
virtual T operator() (T x, T y, T time, T nx, T ny, T curvature) const=0
virtual T GetMaxF1 (T Xmin, T Xmax, T Ymin, T Ymax, T norm2) const=0
virtual T GetMaxF2 (T Xmin, T Xmax, T Ymin, T Ymax, T norm2) const=0
virtual T operator() (int i, int j) const
 Returns the speed rate at a given grid point.

virtual T GetDerivatives (T x, T y, T nx, T ny, T t, T &dFdp, T &dFdx, T &dFdy, T &dFdnx, T &dFdny) const=0
virtual T Get2ndDerivatives (T x, T y, T nx, T ny, T t, T &dFdpdp, T &dFdpdx, T &dFdpdy, T &dFdpdnx, T &dFdpdny, T &dFdxdx, T &dFdxdy, T &dFdxdnx, T &dFdxdny, T &dFdydy, T &dFdydnx, T &dFdydny, T &dFdnxdnx, T &dFdnxdny, T &dFdnydny) const=0
virtual void Save (string FFile) const
 Saves current speed rates.


Protected Attributes

Matrix< T > Values
 Speed rates on grid points.

bool dependence_position
 Does the speed function depend upon the position?

bool dependence_time
 Does the speed function depend upon the time?

bool dependence_normal
 Does the speed function depend upon the normal?

bool dependence_curvature
 Does the speed function depend upon the curvature?


Detailed Description

template<class T>
class Multivac::CSpeedFunction< T >

Base class for speed functions.

Defines the speed functions interface. All speed functions must be defined in the same way.

Note:
This is an abstract class.


Member Function Documentation

template<class T>
Matrix< T > & Multivac::CSpeedFunction< T >::GetValues  )  [inline]
 

Returns the matrix that stores speed rates on grid points.

The matrix is returned by reference.

Returns:
a reference to the matrix that stores speed rates on grid points.

template<class T>
bool Multivac::CSpeedFunction< T >::IsCurvatureDependent  )  const [inline]
 

Does the speed function depend upon the curvature?

Returns:
'true' if the velocity depends upon the curvature, 'false' otherwise.

template<class T>
bool Multivac::CSpeedFunction< T >::IsNormalDependent  )  const [inline]
 

Does the speed function depend upon the normal?

Returns:
'true' if the velocity depends upon the normal, 'false' otherwise.

template<class T>
bool Multivac::CSpeedFunction< T >::IsPositionDependent  )  const [inline]
 

Does the speed function depend upon the position?

Returns:
'true' if the velocity depends upon the position, 'false' otherwise.

template<class T>
bool Multivac::CSpeedFunction< T >::IsTimeDependent  )  const [inline]
 

Does the speed function depend upon the time?

Returns:
'true' if the velocity depends upon the time, 'false' otherwise.

template<class T>
T Multivac::CSpeedFunction< T >::operator() int  i,
int  j
const [inline, virtual]
 

Returns the speed rate at a given grid point.

Parameters:
i row index.
j column index.
Returns:
The speed rate at (i, j).

Reimplemented in Multivac::CConstantSpeed< T >, and Multivac::CPiecewiseConstantSpeed< T >.

template<class T>
void Multivac::CSpeedFunction< T >::Save string  FFile  )  const [virtual]
 

Saves current speed rates.

Parameters:
FFile files where rates will be saved.


The documentation for this class was generated from the following files:
Generated on Mon Apr 19 01:59:16 2004 for Multivac by doxygen 1.3.6-20040222