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

#include <Burgers2D.hpp>

Inherits VariablesT< Burgers2D >.

Public Types

enum  { U = 0 }
 
typedef Scalar2D MODEL
 
- 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

 Burgers2D (const std::string &name)
 
virtual ~Burgers2D ()
 virtual destructor More...
 
- Public Member Functions inherited from VariablesT< Burgers2D >
 VariablesT (const std::string &name)
 constructor More...
 
virtual ~VariablesT ()
 virtual destructor More...
 
virtual std::string type () const
 
virtual void compute_properties (const RealVector &coord, const RealVector &sol, const RealMatrix &grad_sol, physics::Properties &p)
 compute physical properties More...
 
virtual void compute_variables (const physics::Properties &p, RealVector &vars)
 compute variables from properties More...
 
virtual void flux (const physics::Properties &p, RealMatrix &flux)
 compute the physical flux More...
 
virtual void flux (const physics::Properties &p, const RealVector &direction, RealVector &flux)
 compute the physical flux in a direction More...
 
virtual void flux_jacobian_eigen_values (const physics::Properties &p, const RealVector &direction, RealVector &evalues)
 compute the eigen values of the flux jacobians More...
 
virtual void flux_jacobian_eigen_values (const physics::Properties &p, const RealVector &direction, RealVector &evalues, UnaryRealOp &op)
 
virtual void flux_jacobian_eigen_structure (const physics::Properties &p, const RealVector &direction, RealMatrix &Rv, RealMatrix &Lv, RealVector &evalues)
 decompose the eigen structure of the flux jacobians projected on the gradients More...
 
virtual void residual (const physics::Properties &p, RealMatrix flux_jacob[], RealVector &res)
 compute the PDE residual More...
 
virtual math::VariablesDescriptordescription ()
 
- Public Member Functions inherited from Variables
 Variables (const std::string &name)
 
virtual ~Variables ()
 virtual destructor More...
 
- 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...
 
template<typename CV , typename SV , typename GM >
static void compute_properties (const CV &coord, const SV &sol, const GM &grad_vars, MODEL::Properties &p)
 compute physical properties More...
 
template<typename VectorT >
static void compute_variables (const MODEL::Properties &p, VectorT &vars)
 
template<typename FM >
static void flux (const MODEL::Properties &p, FM &flux)
 compute the physical flux More...
 
template<typename FM , typename GV >
static void flux (const MODEL::Properties &p, const GV &direction, FM &flux)
 compute the physical flux More...
 
template<typename GV , typename EV >
static void flux_jacobian_eigen_values (const MODEL::Properties &p, const GV &direction, EV &Dv)
 compute the eigen values of the flux jacobians More...
 
template<typename GV , typename EV , typename OP >
static void flux_jacobian_eigen_values (const MODEL::Properties &p, const GV &direction, EV &Dv, OP &op)
 compute the eigen values of the flux jacobians More...
 
template<typename GV , typename EM , typename EV >
static void flux_jacobian_eigen_structure (const MODEL::Properties &p, const GV &direction, EM &Rv, EM &Lv, EV &Dv)
 decompose the eigen structure of the flux jacobians projected on the gradients More...
 
template<typename JM , typename RV >
static void residual (const MODEL::Properties &p, JM flux_jacob[], RV &res)
 compute the PDE residual More...
 
- Static Public Member Functions inherited from VariablesT< Burgers2D >
static std::string type_name ()
 Get the class name. More...
 
- Static Public Member Functions inherited from Variables
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...
 

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

Detailed Description

Definition at line 23 of file Burgers2D.hpp.

Member Typedef Documentation

typedef Scalar2D MODEL

Definition at line 27 of file Burgers2D.hpp.

Member Enumeration Documentation

anonymous enum
Enumerator

Definition at line 29 of file Burgers2D.hpp.

Constructor & Destructor Documentation

Burgers2D ( const std::string &  name)

constructor

Parameters
nameof the component

Definition at line 23 of file Burgers2D.cpp.

~Burgers2D ( )
virtual

virtual destructor

Definition at line 28 of file Burgers2D.cpp.

Member Function Documentation

static void compute_properties ( const CV &  coord,
const SV &  sol,
const GM &  grad_vars,
MODEL::Properties p 
)
inlinestatic

compute physical properties

Definition at line 48 of file Burgers2D.hpp.

static void compute_variables ( const MODEL::Properties p,
VectorT &  vars 
)
inlinestatic

Definition at line 66 of file Burgers2D.hpp.

static void flux ( const MODEL::Properties p,
FM &  flux 
)
inlinestatic

compute the physical flux

Definition at line 73 of file Burgers2D.hpp.

static void flux ( const MODEL::Properties p,
const GV &  direction,
FM &  flux 
)
inlinestatic

compute the physical flux

Definition at line 82 of file Burgers2D.hpp.

static void flux_jacobian_eigen_structure ( const MODEL::Properties p,
const GV &  direction,
EM &  Rv,
EM &  Lv,
EV &  Dv 
)
inlinestatic

decompose the eigen structure of the flux jacobians projected on the gradients

Definition at line 112 of file Burgers2D.hpp.

static void flux_jacobian_eigen_values ( const MODEL::Properties p,
const GV &  direction,
EV &  Dv 
)
inlinestatic

compute the eigen values of the flux jacobians

Definition at line 92 of file Burgers2D.hpp.

static void flux_jacobian_eigen_values ( const MODEL::Properties p,
const GV &  direction,
EV &  Dv,
OP &  op 
)
inlinestatic

compute the eigen values of the flux jacobians

Definition at line 101 of file Burgers2D.hpp.

static void residual ( const MODEL::Properties p,
JM  flux_jacob[],
RV &  res 
)
inlinestatic

compute the PDE residual

Definition at line 125 of file Burgers2D.hpp.

static std::string type_name ( )
inlinestatic

Get the class name.

Definition at line 44 of file Burgers2D.hpp.


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