COOLFluiD  Release kernel
COOLFluiD is a Collaborative Simulation Environment (CSE) focused on complex MultiPhysics simulations.
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
TermBase< NB_DIM, NB_EQS, NB_VAR, NB_GRAD > Class Template Reference

#include <Term.hpp>

Inherits Term.

Public Types

enum  { ENABLE_CONVECTION = false }
 
enum  { ENABLE_DIFFUSION = false }
 
enum  { ENABLE_SOURCE = false }
 
typedef physics::MatrixTypes< NDIM, NEQS, NVAR, NGRAD >::ColVector_NDIM ColVector_NDIM
 
typedef physics::MatrixTypes< NDIM, NEQS, NVAR, NGRAD >::RowVector_NEQS RowVector_NEQS
 
typedef physics::MatrixTypes< NDIM, NEQS, NVAR, NGRAD >::RowVector_NVAR RowVector_NVAR
 
typedef physics::MatrixTypes< NDIM, NEQS, NVAR, NGRAD >::RowVector_NGRAD RowVector_NGRAD
 
typedef physics::MatrixTypes< NDIM, NEQS, NVAR, NGRAD >::Matrix_NDIMxNDIM Matrix_NDIMxNDIM
 
typedef physics::MatrixTypes< NDIM, NEQS, NVAR, NGRAD >::Matrix_NDIMxNEQS Matrix_NDIMxNEQS
 
typedef physics::MatrixTypes< NDIM, NEQS, NVAR, NGRAD >::Matrix_NDIMxNVAR Matrix_NDIMxNVAR
 
typedef physics::MatrixTypes< NDIM, NEQS, NVAR, NGRAD >::Matrix_NDIMxNGRAD Matrix_NDIMxNGRAD
 
typedef physics::MatrixTypes< NDIM, NEQS, NVAR, NGRAD >::Matrix_NEQSxNEQS Matrix_NEQSxNEQS
 
- Public Types inherited from Component
typedef ComponentIterator< Componentiterator
 type of the iterator to Component More...
 
typedef ComponentIterator< Component const > const_iterator
 type of the iterator to constant Component More...
 
- Public Types inherited from SignalHandler
typedef std::vector< SignalPtrstorage_t
 storage type for signals More...
 

Public Member Functions

 TermBase (const std::string &name)
 Constructor. More...
 
virtual ~TermBase ()
 Destructor. More...
 
void get_variables (const mesh::Space &space, const Uint elem_idx, const ColVector_NDIM &coords, const mesh::ReconstructPoint &interpolation, const std::vector< mesh::ReconstructPoint > &gradient, const Matrix_NDIMxNDIM &jacobian, const Matrix_NDIMxNDIM &jacobian_inverse, const Real &jacobian_determinant, RowVector_NVAR &vars, RowVector_NGRAD &gradvars, Matrix_NDIMxNGRAD &gradvars_grad)
 DONT SPOIL PERFORMANCE, DONT MAKE ANY FUNCTIONS VIRTUAL!!! More...
 
void get_bdry_variables (const mesh::Space &space, const Uint elem_idx, const ColVector_NDIM &coords, const mesh::ReconstructPoint &interpolation, const std::vector< mesh::ReconstructPoint > &gradient, const Matrix_NDIMxNDIM &jacobian, const Matrix_NDIMxNDIM &jacobian_inverse, const Real &jacobian_determinant, RowVector_NVAR &vars, RowVector_NGRAD &gradvars, Matrix_NDIMxNGRAD &gradvars_grad)
 
template<typename DATA >
void set_phys_data_constants (DATA &phys_data)
 Set constants in the data. More...
 
template<typename DATA >
void compute_phys_data (const ColVector_NDIM &coords, const RowVector_NVAR &vars, const RowVector_NGRAD &gradvars, const Matrix_NDIMxNGRAD &gradvars_grad, DATA &phys_data)
 Compute the data from computed variables and gradients. More...
 
template<typename DATA >
void compute_convective_flux (const DATA &p, const ColVector_NDIM &normal, RowVector_NEQS &flux, Real &wave_speed)
 
template<typename DATA >
void compute_riemann_flux (const DATA &left, const DATA &right, const ColVector_NDIM &normal, RowVector_NEQS &flux, Real &wave_speed)
 
template<typename DATA >
void compute_diffusive_flux (const DATA &p, const ColVector_NDIM &normal, RowVector_NEQS &flux, Real &wave_speed)
 
template<typename DATA >
void compute_source (const DATA &p, RowVector_NEQS &source)
 
- Public Member Functions inherited from Term
 Term (const std::string &name)
 
virtual ~Term ()
 
const Handle< mesh::Dictionary > & fields ()
 
const Handle< mesh::Field > & solution ()
 
const Handle< mesh::Dictionary > & bdry_fields ()
 
const Handle< mesh::Field > & bdry_solution ()
 
const Handle< mesh::Field > & bdry_solution_gradient ()
 
const Handle< solver::Time > & time () const
 
virtual void create_fields ()
 
virtual void create_bdry_fields ()
 
- Public Member Functions inherited from Component
 Component (const std::string &name)
 
virtual ~Component ()
 Virtual destructor. More...
 
const std::string & name () const
 Access the name of the component. More...
 
void rename (const std::string &name)
 Rename the component. More...
 
URI uri () const
 Construct the full path. More...
 
void complete_path (URI &path) const
 
Handle< Componentaccess_component (const URI &path) const
 
Handle< Componentaccess_component_checked (const URI &path)
 
Handle< Component const > access_component_checked (const URI &path) const
 
Handle< Componenthandle ()
 Get a handle to the component. More...
 
Handle< Component const > handle () const
 
template<typename ComponentT >
Handle< ComponentT > handle ()
 
template<typename ComponentT >
Handle< ComponentT const > handle () const
 
Handle< Componentparent () const
 
Handle< Component const > root () const
 
Handle< Componentroot ()
 
Handle< Componentget_child (const std::string &name)
 
Handle< Component const > get_child (const std::string &name) const
 
Handle< Componentget_child_checked (const std::string &name)
 
Handle< Component const > get_child_checked (const std::string &name) const
 
Handle< Componentcreate_component (const std::string &name, const std::string &builder)
 Build a (sub)component of this component using the extended type_name of the component. More...
 
template<typename T >
Handle< T > create_component (const std::string &name)
 Create a (sub)component of this component automatically cast to the specified type. More...
 
template<typename T >
Handle< T > create_static_component (const std::string &name)
 Create a static "always there" subcomponent. More...
 
Componentadd_component (const boost::shared_ptr< Component > &subcomp)
 Add the passed component as a subcomponent. More...
 
void add_link (Component &linked_component)
 
boost::shared_ptr< Componentremove_component (const std::string &name)
 Remove a (sub)component of this component. More...
 
boost::shared_ptr< Componentremove_component (Component &subcomp)
 Remove a (sub)component of this component. More...
 
void clear ()
 Remove all sub-components of this component, except for the static ones. More...
 
void move_to (Component &to_parent)
 
std::string tree (bool basic_mode=false, Uint depth=0, Uint recursion_level=0) const
 
std::string info (const std::string &what=std::string("cospt")) const
 
size_t count_children () const
 
virtual std::string derived_type_name () const =0
 
PropertyListproperties ()
 
const PropertyListproperties () const
 
OptionListoptions ()
 
const OptionListoptions () const
 
void reset_options ()
 Reset all options to their default value. More...
 
void configure_option_recursively (const std::string &optname, const boost::any &val)
 
Componentmark_basic ()
 marks this component as basic. More...
 
template<typename ComponentT >
void put_components (std::vector< boost::shared_ptr< ComponentT > > &vec, const bool recurse)
 
template<typename ComponentT >
void put_components (std::vector< boost::shared_ptr< ComponentT const > > &vec, const bool recurse) const
 
template<>
void put_components (std::vector< boost::shared_ptr< Component > > &vec, const bool recurse)
 
template<>
void put_components (std::vector< boost::shared_ptr< Component const > > &vec, const bool recurse) const
 
Component::iterator begin ()
 The begin iterator for a range containing Components. More...
 
Component::iterator end ()
 The end iterator for a range containing Components. More...
 
Component::const_iterator begin () const
 The begin iterator for a range containing Components (const version) More...
 
Component::const_iterator end () const
 The end iterator for a range containing Components (const version) More...
 
Component::iterator recursive_begin ()
 The begin iterator for a recursive range containing Components. More...
 
Component::iterator recursive_end ()
 The end iterator for a recursive range containing Components. More...
 
Component::const_iterator recursive_begin () const
 The begin iterator for a recursive range containing Components (const version) More...
 
Component::const_iterator recursive_end () const
 The end iterator for a recursive range containing Components (const version) More...
 
template<typename T >
Handle< T > create_component (const std::string &name, const std::string &builder)
 Create a component using the reduced builder name. More...
 
void signal_configure (SignalArgs &args)
 configures all the options on this class More...
 
void signal_create_component (SignalArgs &args)
 creates a component from this component More...
 
void signal_delete_component (SignalArgs &args)
 delete this component More...
 
void signal_move_component (SignalArgs &args)
 moves a component from this component to another More...
 
void signal_list_tree (SignalArgs &args) const
 lists the sub components and puts them on the xml_tree More...
 
void signal_list_tree_recursive (SignalArgs &args) const
 prints tree recursively More...
 
void signal_list_properties (SignalArgs &args) const
 lists the properties of this component More...
 
void signal_list_options (SignalArgs &args) const
 lists the properties of this component More...
 
void signal_list_options_recursive (SignalArgs &args) const
 prints all options recursive More...
 
void signal_list_signals (SignalArgs &args) const
 lists the signals of this component More...
 
void signal_list_signals_recursive (SignalArgs &args) const
 prints all signals recursive More...
 
void signal_print_info (SignalArgs &args) const
 gets info on this component More...
 
void signal_print_tree (SignalArgs &args) const
 signal to print the tree More...
 
void signature_print_tree (SignalArgs &args) const
 signature to signal_print_tree More...
 
void signal_rename_component (SignalArgs &args)
 renames this component More...
 
void signal_save_tree (SignalArgs &args)
 dumps the tree to a file More...
 
void signal_list_content (SignalArgs &args)
 gives information about this component such as options, signals, ... More...
 
void signal_signature (SignalArgs &args)
 Gives a signal signature, if any. More...
 
void signature_create_component (SignalArgs &args)
 
void signature_rename_component (SignalArgs &args)
 
void signature_move_component (SignalArgs &args)
 
void signal_store_timings (SignalArgs &args)
 Signal to store the timings (if enabled) into properties, i.e. for readout from python or the GUI. More...
 
void signal_clear (SignalArgs &args)
 Signal to remove all sub-components. More...
 
void signal_reset_options (SignalArgs &args)
 Signal to set all options to their default value. More...
 
void signal_add_tag (SignalArgs &args)
 Signal to add a tag. More...
 
void signature_add_tag (SignalArgs &args)
 
- Public Member Functions inherited from SignalHandler
 ~SignalHandler ()
 
const storage_tsignal_list () const
 
SignalPtr signal (const SignalID &sname)
 
SignalCPtr signal (const SignalID &sname) const
 
SignalRet call_signal (const SignalID &sname, SignalArgs &sinput)
 Calls the signal by providing its name and input. More...
 
SignalRet call_signal (const SignalID &sname, std::vector< std::string > &sinput)
 Calls the signal by providing its name and input. More...
 
bool signal_exists (const SignalID &sname) const
 Checks if a signal exists or not. More...
 
Signalregist_signal (const SignalID &sname)
 Regist signal. More...
 
void unregist_signal (const SignalID &sname)
 Unregist signal. More...
 
- Public Member Functions inherited from ConnectionManager
 ~ConnectionManager ()
 destructor closes all connections More...
 
Connectionconnection (const std::string &name)
 
Connectionmanage_connection (const std::string &name)
 manages a connection (creates if necessary) More...
 
- Public Member Functions inherited from TaggedObject
 TaggedObject ()
 Constructor. More...
 
bool has_tag (const std::string &tag) const
 
void add_tag (const std::string &tag)
 
std::vector< std::string > get_tags () const
 
void remove_tag (const std::string &tag)
 

Static Public Member Functions

static std::string type_name ()
 
- Static Public Member Functions inherited from Term
static std::string type_name ()
 
- Static Public Member Functions inherited from Component
static std::string type_name ()
 Get the class name. More...
 

Static Public Attributes

static const Uint NDIM = NB_DIM
 
static const Uint NEQS = NB_EQS
 
static const Uint NVAR = NB_VAR
 
static const Uint NGRAD = NB_GRAD
 

Additional Inherited Members

- Public Attributes inherited from SignalHandler
storage_t m_signals
 storage of the signals More...
 
- Protected Member Functions inherited from Component
Componentadd_static_component (const boost::shared_ptr< Component > &subcomp)
 Add a static (sub)component of this component. More...
 
void raise_tree_updated_event ()
 raise event that the path has changed More...
 
- Protected Attributes inherited from Term
Handle< mesh::Dictionarym_fields
 
Handle< mesh::Fieldm_solution
 
Handle< mesh::Dictionarym_bdry_fields
 
Handle< mesh::Fieldm_bdry_solution
 
Handle< mesh::Fieldm_bdry_solution_gradient
 
Handle< solver::Timem_time
 

Detailed Description

template<Uint NB_DIM, Uint NB_EQS, Uint NB_VAR, Uint NB_GRAD>
class cf3::solver::TermBase< NB_DIM, NB_EQS, NB_VAR, NB_GRAD >

Definition at line 79 of file Term.hpp.

Member Typedef Documentation

Definition at line 102 of file Term.hpp.

Definition at line 106 of file Term.hpp.

Definition at line 107 of file Term.hpp.

Definition at line 109 of file Term.hpp.

Definition at line 108 of file Term.hpp.

Definition at line 110 of file Term.hpp.

Definition at line 103 of file Term.hpp.

Definition at line 105 of file Term.hpp.

Definition at line 104 of file Term.hpp.

Member Enumeration Documentation

anonymous enum
Enumerator
ENABLE_CONVECTION 

Definition at line 93 of file Term.hpp.

anonymous enum
Enumerator
ENABLE_DIFFUSION 

Definition at line 94 of file Term.hpp.

anonymous enum
Enumerator
ENABLE_SOURCE 

Definition at line 95 of file Term.hpp.

Constructor & Destructor Documentation

TermBase ( const std::string &  name)
inline

Constructor.

Definition at line 84 of file Term.hpp.

virtual ~TermBase ( )
inlinevirtual

Destructor.

Definition at line 87 of file Term.hpp.

Member Function Documentation

void compute_convective_flux ( const DATA &  p,
const ColVector_NDIM normal,
RowVector_NEQS flux,
Real &  wave_speed 
)
inline

Definition at line 157 of file Term.hpp.

void compute_diffusive_flux ( const DATA &  p,
const ColVector_NDIM normal,
RowVector_NEQS flux,
Real &  wave_speed 
)
inline

Definition at line 173 of file Term.hpp.

void compute_phys_data ( const ColVector_NDIM coords,
const RowVector_NVAR vars,
const RowVector_NGRAD gradvars,
const Matrix_NDIMxNGRAD gradvars_grad,
DATA &  phys_data 
)
inline

Compute the data from computed variables and gradients.

Definition at line 147 of file Term.hpp.

void compute_riemann_flux ( const DATA &  left,
const DATA &  right,
const ColVector_NDIM normal,
RowVector_NEQS flux,
Real &  wave_speed 
)
inline

Definition at line 165 of file Term.hpp.

void compute_source ( const DATA &  p,
RowVector_NEQS source 
)
inline

Definition at line 181 of file Term.hpp.

void get_bdry_variables ( const mesh::Space space,
const Uint  elem_idx,
const ColVector_NDIM coords,
const mesh::ReconstructPoint interpolation,
const std::vector< mesh::ReconstructPoint > &  gradient,
const Matrix_NDIMxNDIM jacobian,
const Matrix_NDIMxNDIM jacobian_inverse,
const Real &  jacobian_determinant,
RowVector_NVAR vars,
RowVector_NGRAD gradvars,
Matrix_NDIMxNGRAD gradvars_grad 
)
inline

Definition at line 129 of file Term.hpp.

void get_variables ( const mesh::Space space,
const Uint  elem_idx,
const ColVector_NDIM coords,
const mesh::ReconstructPoint interpolation,
const std::vector< mesh::ReconstructPoint > &  gradient,
const Matrix_NDIMxNDIM jacobian,
const Matrix_NDIMxNDIM jacobian_inverse,
const Real &  jacobian_determinant,
RowVector_NVAR vars,
RowVector_NGRAD gradvars,
Matrix_NDIMxNGRAD gradvars_grad 
)
inline

DONT SPOIL PERFORMANCE, DONT MAKE ANY FUNCTIONS VIRTUAL!!!

Compute variables and gradients in a given element point

Definition at line 117 of file Term.hpp.

void set_phys_data_constants ( DATA &  phys_data)
inline

Set constants in the data.

Definition at line 143 of file Term.hpp.

static std::string type_name ( )
inlinestatic

Definition at line 89 of file Term.hpp.

Member Data Documentation

const Uint NDIM = NB_DIM
static

Definition at line 97 of file Term.hpp.

const Uint NEQS = NB_EQS
static

Definition at line 98 of file Term.hpp.

const Uint NGRAD = NB_GRAD
static

Definition at line 100 of file Term.hpp.

const Uint NVAR = NB_VAR
static

Definition at line 99 of file Term.hpp.


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