#include <LSSAction.hpp>

Inherits ActionDirector.

Inherited by PoissonManual, PoissonProto, PoissonSpecialized, PoissonVirtual, HeatConductionSteady, LSSActionUnsteady, and StokesSteady.

Classes
struct	Implementation

Public Member Functions
	LSSAction (const std::string &name)

virtual	~LSSAction ()

virtual void	execute ()
	Execute all active child actions. More...

math::LSS::System &	create_lss ()
	Create the LSS to use. More...

std::string	solution_tag ()
	Access to the tag this component uses for finding its solution field. More...

void	set_solution_tag (const std::string &tag)
	Set the tag used to keep track of what field stores the solution to the LSS. More...

Public Member Functions inherited from ActionDirector
	ActionDirector (const std::string &name)

Public Member Functions inherited from Action
	Action (const std::string &name)

virtual Action &	create_action (const std::string &action_provider, const std::string &name)

void	signal_execute (common::SignalArgs &node)
	signal to execute this action More...

Public Member Functions inherited from IAction
virtual	~IAction ()

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< Component >	access_component (const URI &path) const

Handle< Component >	access_component_checked (const URI &path)

Handle< Component const >	access_component_checked (const URI &path) const

Handle< Component >	handle ()
	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< Component >	parent () const

Handle< Component const >	root () const

Handle< Component >	root ()

Handle< Component >	get_child (const std::string &name)

Handle< Component const >	get_child (const std::string &name) const

Handle< Component >	get_child_checked (const std::string &name)

Handle< Component const >	get_child_checked (const std::string &name) const

Handle< Component >	create_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...

Component &	add_component (const boost::shared_ptr< Component > &subcomp)
	Add the passed component as a subcomponent. More...

void	add_link (Component &linked_component)

boost::shared_ptr< Component >	remove_component (const std::string &name)
	Remove a (sub)component of this component. More...

boost::shared_ptr< Component >	remove_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

PropertyList &	properties ()

const PropertyList &	properties () const

OptionList &	options ()

const OptionList &	options () const

void	reset_options ()
	Reset all options to their default value. More...

void	configure_option_recursively (const std::string &optname, const boost::any &val)

Component &	mark_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_t &	signal_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...

Signal &	regist_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...

Connection *	connection (const std::string &name)

Connection *	manage_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 ActionDirector
static std::string	type_name ()
	Get the class name. More...

Static Public Member Functions inherited from Action
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...

Public Attributes
const solver::actions::Proto::SystemMatrix &	system_matrix
	Proto placeholder for the system matrix. More...

const solver::actions::Proto::SystemRHS &	system_rhs
	Proto placeholder for the right hand side of the system. More...

const solver::actions::Proto::DirichletBC &	dirichlet
	Proto placeholder for dirichlet boundary conditions. More...

const solver::actions::Proto::SolutionVector &	solution
	Proto placeholder for the solution vector. More...

Public Attributes inherited from SignalHandler
storage_t	m_signals
	storage of the signals More...

Protected Member Functions
virtual void	on_regions_set ()
	Called when the regions are set. More...

virtual void	on_initial_conditions_set (InitialConditions &initial_conditions)
	Called when the initial conditions are set. More...

virtual void	do_create_lss (common::PE::CommPattern &cp, const math::VariablesDescriptor &vars, std::vector< Uint > &node_connectivity, std::vector< Uint > &starting_indices, const std::vector< Uint > &periodic_links_nodes, const std::vector< bool > &periodic_links_active)
	Called to actually create the LSS. Parameters are described in the LSS interface. More...

Protected Member Functions inherited from ActionDirector
bool	is_disabled (const std::string &name)
	True if the passed action is disabled. More...

Protected Member Functions inherited from Component
Component &	add_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...

Private Member Functions
void	signal_create_lss (common::SignalArgs &node)
	Signals. More...

void	trigger_dictionary ()
	trigger for the dictionary More...

void	trigger_initial_conditions ()
	Trigger for the initial conditions. More...

Private Attributes
boost::scoped_ptr< Implementation >	m_implementation

Handle< mesh::Dictionary >	m_dictionary
	The dictionary to use for field lookups. More...

Handle< InitialConditions >	m_initial_conditions
	Component that sets initial conditions. More...

std::vector< Handle< common::Component > >	m_created_initial_conditions
	The initial conditions that apply to the current LSSAction. More...

Additional Inherited Members
Public Types inherited from Component
typedef ComponentIterator< Component >	iterator
	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< SignalPtr >	storage_t
	storage type for signals More...

Detailed Description

LSSAction for UFEM problems, allowing dynamic configuration and providing access to

Linear system solver
Physical model
Mesh used
Region to loop over

Definition at line 44 of file LSSAction.hpp.

Constructor & Destructor Documentation

LSSAction ( const std::string & name )

Contructor

Parameters

name	of the component

Definition at line 76 of file LSSAction.cpp.

~LSSAction ( )

virtual

Definition at line 118 of file LSSAction.cpp.

Member Function Documentation

LSS::System & create_lss ( )

Create the LSS to use.

Definition at line 137 of file LSSAction.cpp.

void do_create_lss	(	common::PE::CommPattern &	cp,
		const math::VariablesDescriptor &	vars,
		std::vector< Uint > &	node_connectivity,
		std::vector< Uint > &	starting_indices,
		const std::vector< Uint > &	periodic_links_nodes,
		const std::vector< bool > &	periodic_links_active
	)

protectedvirtual

Called to actually create the LSS. Parameters are described in the LSS interface.

Reimplemented in PressureSystem.

Definition at line 363 of file LSSAction.cpp.

void execute ( )

virtual

Execute all active child actions.

Reimplemented from ActionDirector.

Reimplemented in NavierStokesManual.

Definition at line 122 of file LSSAction.cpp.

void on_initial_conditions_set ( InitialConditions & initial_conditions )

protectedvirtual

Called when the initial conditions are set.

Reimplemented in SpalartAllmaras, NavierStokes, NavierStokesManual, PoissonVirtual, NavierStokesSpecialized, StokesSteady, and HeatConductionSteady.

Definition at line 359 of file LSSAction.cpp.

void on_regions_set ( )

protectedvirtual

Called when the regions are set.

Definition at line 165 of file LSSAction.cpp.

void set_solution_tag ( const std::string & tag )

Set the tag used to keep track of what field stores the solution to the LSS.

Definition at line 354 of file LSSAction.cpp.

void signal_create_lss ( common::SignalArgs & node )

private

Signals.

Definition at line 155 of file LSSAction.cpp.

std::string solution_tag ( )

Access to the tag this component uses for finding its solution field.

Definition at line 349 of file LSSAction.cpp.

void trigger_dictionary ( )

private

trigger for the dictionary

Definition at line 305 of file LSSAction.cpp.

void trigger_initial_conditions ( )

private

Trigger for the initial conditions.

Definition at line 317 of file LSSAction.cpp.

static std::string type_name ( )

inlinestatic

Get the class name.

Definition at line 55 of file LSSAction.hpp.

Member Data Documentation

const solver::actions::Proto::DirichletBC& dirichlet

Proto placeholder for dirichlet boundary conditions.

Definition at line 107 of file LSSAction.hpp.

std::vector< Handle<common::Component> > m_created_initial_conditions

private

The initial conditions that apply to the current LSSAction.

Definition at line 88 of file LSSAction.hpp.

Handle<mesh::Dictionary> m_dictionary

private

The dictionary to use for field lookups.

Definition at line 82 of file LSSAction.hpp.

boost::scoped_ptr<Implementation> m_implementation

private

Definition at line 69 of file LSSAction.hpp.

Handle<InitialConditions> m_initial_conditions

private

Component that sets initial conditions.

Definition at line 85 of file LSSAction.hpp.

const solver::actions::Proto::SolutionVector& solution

Proto placeholder for the solution vector.

Definition at line 109 of file LSSAction.hpp.

const solver::actions::Proto::SystemMatrix& system_matrix

Proto placeholder for the system matrix.

Definition at line 103 of file LSSAction.hpp.

const solver::actions::Proto::SystemRHS& system_rhs

Proto placeholder for the right hand side of the system.

Definition at line 105 of file LSSAction.hpp.

The documentation for this class was generated from the following files:

plugins/UFEM/src/UFEM/LSSAction.hpp
plugins/UFEM/src/UFEM/LSSAction.cpp

Classes

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation