ExpressionBase< ExprT > Class Template Reference

Boilerplate implementation. More...

#include <Expression.hpp>

Inherits Expression.

Inherited by ElementsExpression< ExprT, ElementTypes >, and NodesExpression< ExprT, DimsT >.

Classes
struct	AppendTags
	Functor to store the tags used by a field. More...
struct	RegisterVariables
	Functor to register variables in a physical model. More...

Public Member Functions
	ExpressionBase (const ExprT &expr)
void	add_options (common::OptionList &options)
virtual PhysicsConstantStorage &	physics_constants ()
	Returns the list of physics constants referred to by this expression. More...
void	register_variables (physics::PhysModel &physical_model)
	Register the variables that appear in the expression with a physical model. More...
void	insert_field_info (std::map< std::string, std::string > &tags) const
Public Member Functions inherited from Expression
virtual void	loop (mesh::Region &region)=0
	Run the stored expression in a loop over the region. More...
virtual	~Expression ()

Protected Types
typedef boost::result_of< DeepCopy(typename boost::result_of< ReplaceConfigurableConstants(typename boost::result_of< ReplacePhysicsConstants(ExprT, PhysicsConstantStorage)>::type, ConstantStorage)>::type) >::type	CopiedExprT
	Store a copy of the expression. More...
typedef ExpressionProperties< ExprT >::NbVarsT	NbVarsT
typedef ExpressionProperties< ExprT >::VariablesT	VariablesT
typedef EquationVariables< ExprT, NbVarsT >::type	EquationVariablesT

Protected Attributes
CopiedExprT	m_expr
VariablesT	m_variables

Private Attributes
ConstantStorage	m_constant_values
	Values for configurable constants. More...
PhysicsConstantStorage	m_physics_values
	Values for physics constants. More...

Detailed Description

template<typename ExprT>
class cf3::solver::actions::Proto::ExpressionBase< ExprT >

Boilerplate implementation.

Definition at line 73 of file Expression.hpp.

Member Typedef Documentation

typedef boost::result_of< DeepCopy(typename boost::result_of<ReplaceConfigurableConstants(typename boost::result_of<ReplacePhysicsConstants(ExprT, PhysicsConstantStorage)>::type, ConstantStorage)>::type) >::type CopiedExprT

protected

Store a copy of the expression.

Definition at line 155 of file Expression.hpp.

typedef EquationVariables<ExprT, NbVarsT>::type EquationVariablesT

protected

Definition at line 166 of file Expression.hpp.

typedef ExpressionProperties<ExprT>::NbVarsT NbVarsT

protected

Definition at line 159 of file Expression.hpp.

typedef ExpressionProperties<ExprT>::VariablesT VariablesT

protected

Definition at line 162 of file Expression.hpp.

Constructor & Destructor Documentation

ExpressionBase ( const ExprT &  expr )

inline

Definition at line 77 of file Expression.hpp.

Member Function Documentation

void add_options ( common::OptionList &  options )

inlinevirtual

Generate the required options for configurable items in the expression If an option already existed, only a link will be created

Parameters

options

The optionlist that will hold the generated options

Implements Expression.

Definition at line 86 of file Expression.hpp.

void insert_field_info ( std::map< std::string, std::string > &  tags ) const

inlinevirtual

Complete the passed map with field information used by the stored expression. The map is built as follows: key: the tag for the field to use or create value: space library name, to indicate what kind of field is expected

Implements Expression.

Definition at line 142 of file Expression.hpp.

virtual PhysicsConstantStorage& physics_constants ( )

inlinevirtual

Returns the list of physics constants referred to by this expression.

Implements Expression.

Definition at line 132 of file Expression.hpp.

void register_variables ( physics::PhysModel &  physical_model )

inlinevirtual

Register the variables that appear in the expression with a physical model.

Implements Expression.

Definition at line 137 of file Expression.hpp.

Member Data Documentation

ConstantStorage m_constant_values

private

Values for configurable constants.

Definition at line 149 of file Expression.hpp.

CopiedExprT m_expr

protected

Definition at line 156 of file Expression.hpp.

PhysicsConstantStorage m_physics_values

private

Values for physics constants.

Definition at line 151 of file Expression.hpp.

VariablesT m_variables

protected

Definition at line 163 of file Expression.hpp.

---

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

• cf3/solver/actions/Proto/Expression.hpp