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

#include <PhysModel.hpp>

Inherits Component.

Inherited by DynamicModel, LinEuler2D, LinEuler3D, Scalar1D, Scalar2D, Scalar3D, and ScalarSys2D.

Public Member Functions

 PhysModel (const std::string &name)
 
virtual ~PhysModel ()
 Virtual destructor. More...
 
void signal_create_variables (common::SignalArgs &args)
 
void signature_create_variables (common::SignalArgs &args)
 
math::VariableManagervariable_manager ()
 Access to the VariableManager. More...
 
const math::VariableManagervariable_manager () const
 
INTERFACE
virtual Uint ndim () const =0
 
virtual Uint neqs () const =0
 
virtual std::string model_type () const =0
 
virtual std::string type () const =0
 
virtual std::auto_ptr< physics::Propertiescreate_properties ()=0
 create a physical properties More...
 
virtual boost::shared_ptr< physics::Variablescreate_variables (const std::string type, const std::string name)=0
 
- 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 ()
 Get the class name. More...
 
- Static Public Member Functions inherited from Component
static std::string type_name ()
 Get the class name. More...
 

Private Attributes

math::VariableManagerm_variable_manager
 

Additional Inherited Members

- 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 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...
 

Detailed Description

Component providing information about the physics

Author
Tiago Quintino
Willem Deconinck
Bart Janssens

Definition at line 31 of file PhysModel.hpp.

Constructor & Destructor Documentation

PhysModel ( const std::string &  name)

Contructor

Parameters
nameof the component

Definition at line 25 of file PhysModel.cpp.

~PhysModel ( )
virtual

Virtual destructor.

Definition at line 38 of file PhysModel.cpp.

Member Function Documentation

virtual std::auto_ptr< physics::Properties > create_properties ( )
pure virtual

create a physical properties

Implemented in LinEuler3D, LinEuler2D, Scalar1D, Scalar3D, ScalarSys2D, Scalar2D, and DynamicModel.

virtual boost::shared_ptr< physics::Variables > create_variables ( const std::string  type,
const std::string  name 
)
pure virtual

Create a Variables component

Parameters
typeis the name of the Variables
Postcondition
the component will be a sub-component of this model but maybe be moved away
Exceptions
ValueNotFoundif the type does not match a variable type this model supports

Implemented in LinEuler3D, LinEuler2D, Scalar1D, Scalar3D, ScalarSys2D, Scalar2D, and DynamicModel.

virtual std::string model_type ( ) const
pure virtual
Returns
the physical model generic type

Implemented in LinEuler3D, LinEuler2D, Scalar1D, Scalar3D, ScalarSys2D, Scalar2D, and DynamicModel.

virtual Uint ndim ( ) const
pure virtual
Returns
dimensionality of the problem, which is the number of spatial coordinates used in the PDEs

Implemented in LinEuler3D, LinEuler2D, Scalar1D, Scalar3D, ScalarSys2D, Scalar2D, and DynamicModel.

virtual Uint neqs ( ) const
pure virtual
Returns
number of independent variables in the PDE

Implemented in LinEuler3D, LinEuler2D, Scalar1D, Scalar3D, ScalarSys2D, Scalar2D, and DynamicModel.

void signal_create_variables ( common::SignalArgs args)

Definition at line 54 of file PhysModel.cpp.

void signature_create_variables ( common::SignalArgs args)

Definition at line 66 of file PhysModel.cpp.

virtual std::string type ( ) const
pure virtual
Returns
the physical model type

Implemented in LinEuler3D, LinEuler2D, Scalar1D, Scalar3D, ScalarSys2D, Scalar2D, and DynamicModel.

static std::string type_name ( )
inlinestatic

Get the class name.

Definition at line 48 of file PhysModel.hpp.

math::VariableManager & variable_manager ( )

Access to the VariableManager.

Definition at line 42 of file PhysModel.cpp.

const math::VariableManager & variable_manager ( ) const

Definition at line 47 of file PhysModel.cpp.

Member Data Documentation

math::VariableManager& m_variable_manager
private

Definition at line 85 of file PhysModel.hpp.


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