FieldBase Struct Reference

Base class for field data. More...

#include <Terminals.hpp>

Inherited by ScalarField, and VectorField.

Public Member Functions
	FieldBase ()
	FieldBase (const std::string &name, const std::string &field_tag, const std::string &space_lib_name="geometry")
const std::string &	name () const
const std::string &	field_tag () const
const std::string &	space_lib_name () const

Private Attributes
std::string	m_name
std::string	m_field_tag
std::string	m_space_lib_name

Detailed Description

Base class for field data.

Definition at line 100 of file Terminals.hpp.

Constructor & Destructor Documentation

FieldBase ( )

inline

Definition at line 102 of file Terminals.hpp.

FieldBase ( const std::string &  name, const std::string &  field_tag, const std::string &  space_lib_name = "geometry"  )

inline

Construct a new field placeholder

Parameters

name	Variable name for the represented quantity (i.e. Temperature)
field_tag	Tag to identify the field
space_lib_name	The name of the space library used for the field

Definition at line 110 of file Terminals.hpp.

Member Function Documentation

const std::string& field_tag ( ) const

inline

Definition at line 122 of file Terminals.hpp.

const std::string& name ( ) const

inline

Definition at line 117 of file Terminals.hpp.

const std::string& space_lib_name ( ) const

inline

Definition at line 127 of file Terminals.hpp.

Member Data Documentation

std::string m_field_tag

private

Definition at line 134 of file Terminals.hpp.

std::string m_name

private

Definition at line 133 of file Terminals.hpp.

std::string m_space_lib_name

private

Definition at line 135 of file Terminals.hpp.

---

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

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