COOLFluiD  Release kernel
COOLFluiD is a Collaborative Simulation Environment (CSE) focused on complex MultiPhysics simulations.
Public Member Functions | List of all members
Expression Class Referenceabstract

Abstract interface for classes that can hold a proto expression. More...

#include <Expression.hpp>

Inherited by ExpressionBase< ExprT >.

Public Member Functions

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

Detailed Description

Abstract interface for classes that can hold a proto expression.

Definition at line 46 of file Expression.hpp.

Constructor & Destructor Documentation

virtual ~Expression ( )
inlinevirtual

Definition at line 68 of file Expression.hpp.

Member Function Documentation

virtual void add_options ( common::OptionList options)
pure virtual

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

Parameters
optionsThe optionlist that will hold the generated options

Implemented in ExpressionBase< ExprT >.

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

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

Implemented in ExpressionBase< ExprT >.

virtual void loop ( mesh::Region region)
pure virtual

Run the stored expression in a loop over the region.

Implemented in NodesExpression< ExprT, DimsT >, and ElementsExpression< ExprT, ElementTypes >.

virtual PhysicsConstantStorage& physics_constants ( )
pure virtual

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

Implemented in ExpressionBase< ExprT >.

virtual void register_variables ( physics::PhysModel physical_model)
pure virtual

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

Implemented in ExpressionBase< ExprT >.


The documentation for this class was generated from the following file:
Send comments to:
COOLFluiD Web Admin