ablate::mathFunctions::FieldFunction Class Reference

#include <fieldFunction.hpp>

Inheritance diagram for ablate::mathFunctions::FieldFunction:

Public Member Functions
	FieldFunction (std::string fieldName, std::shared_ptr< mathFunctions::MathFunction > solutionField, std::shared_ptr< mathFunctions::MathFunction > timeDerivative={}, std::shared_ptr< ablate::domain::Region > region=nullptr)
const std::string &	GetName () const
bool	HasSolutionField () const
mathFunctions::MathFunction &	GetSolutionField ()
std::shared_ptr< mathFunctions::MathFunction >	GetFieldFunction () const
bool	HasTimeDerivative () const
mathFunctions::MathFunction &	GetTimeDerivative ()
std::shared_ptr< mathFunctions::MathFunction >	GetTimeDerivativeFunction () const
const std::shared_ptr< ablate::domain::Region > &	GetRegion () const

Detailed Description

Class used to describe initial or exaction conditions of a field using a math function

Member Function Documentation

GetFieldFunction()

std::shared_ptr<mathFunctions::MathFunction> ablate::mathFunctions::FieldFunction::GetFieldFunction ( ) const

inline

Return pointer to math function for field

Returns

GetName()

const std::string& ablate::mathFunctions::FieldFunction::GetName ( ) const

inline

The name of the field

Returns

GetRegion()

const std::shared_ptr<ablate::domain::Region>& ablate::mathFunctions::FieldFunction::GetRegion ( ) const

inline

Return the valid function for this field function

Returns

GetSolutionField()

mathFunctions::MathFunction& ablate::mathFunctions::FieldFunction::GetSolutionField ( )

inline

Return reference to the solution field

Returns

GetTimeDerivative()

mathFunctions::MathFunction& ablate::mathFunctions::FieldFunction::GetTimeDerivative ( )

inline

Return reference to the time derivative field

Returns

GetTimeDerivativeFunction()

std::shared_ptr<mathFunctions::MathFunction> ablate::mathFunctions::FieldFunction::GetTimeDerivativeFunction ( ) const

inline

Return pointer to time derivative field

Returns

HasSolutionField()

bool ablate::mathFunctions::FieldFunction::HasSolutionField ( ) const

inline

Returns bool if this field function has a solution field

Returns

HasTimeDerivative()

bool ablate::mathFunctions::FieldFunction::HasTimeDerivative ( ) const

inline

Returns bool if this field function has a time derivative field

Returns

---

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

• src/mathFunctions/fieldFunction.hpp
• src/mathFunctions/fieldFunction.cpp