Solver base class to solve Partial Differential Equations, defined in class PDE. More...

#include <PDESolver.hpp>

Inherits Action.

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

virtual	~PDESolver ()
	Virtual destructor. More...

const Handle< solver::History > &	history ()

const Handle< solver::ComputeLNorm > &	norm_computer ()

virtual void	execute ()
	execute the action More...

virtual void	setup ()

void	do_iteration ()

void	solve_time_step (const Real time_step)

void	solve_iterations (const Uint nb_iterations)

virtual void	step ()=0

virtual void	iteration_summary ()

bool	stop_condition ()

const Handle< solver::TimeStepComputer >	time_step_computer ()

void	signal_solve_time_step (common::SignalArgs &args)

void	signature_solve_time_step (common::SignalArgs &args)

void	signal_solve_iterations (common::SignalArgs &args)

void	signature_solve_iterations (common::SignalArgs &args)

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

Protected Member Functions
void	raise_iteration_done ()
	raises the event when iteration done More...

void	config_solution ()

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

Protected Attributes
Handle< solver::PDE >	m_pde

Handle< solver::TimeStepComputer >	m_time_step_computer

Handle< common::ActionDirector >	m_pre_iteration
	set of actions called every iteration before non-linear solve More...

Handle< common::ActionDirector >	m_post_iteration
	set of actions called every iteration after non-linear solve More...

Handle< common::ActionDirector >	m_prepare_function

Handle< common::ActionDirector >	m_function

Handle< common::ActionDirector >	m_pre_update

Handle< common::ActionDirector >	m_post_update

Handle< solver::History >	m_history
	Component tracking history of several variables. More...

Handle< solver::ComputeLNorm >	m_norm_computer

Private Member Functions
void	set_time_step_computer ()

void	config_time_step_computer ()

void	config_history ()

void	config_norm_computer ()

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

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

Detailed Description

Solver base class to solve Partial Differential Equations, defined in class PDE.

Author: Willem Deconinck

Definition at line 43 of file PDESolver.hpp.

Constructor & Destructor Documentation

PDESolver ( const std::string & name )

Contructor

Parameters

name	of the component

Definition at line 47 of file PDESolver.cpp.

virtual ~PDESolver ( )

inlinevirtual

Virtual destructor.

Definition at line 52 of file PDESolver.hpp.

Member Function Documentation

void config_history ( )

private

Definition at line 91 of file PDESolver.cpp.

void config_norm_computer ( )

private

Definition at line 100 of file PDESolver.cpp.

void config_solution ( )

protected

void config_time_step_computer ( )

private

Definition at line 124 of file PDESolver.cpp.

void do_iteration ( )

Definition at line 159 of file PDESolver.cpp.

void execute ( )

virtual

execute the action

Implements Action.

Definition at line 213 of file PDESolver.cpp.

const Handle< solver::History >& history ( )

inline

Definition at line 57 of file PDESolver.hpp.

void iteration_summary ( )

virtual

Definition at line 232 of file PDESolver.cpp.

const Handle< solver::ComputeLNorm >& norm_computer ( )

inline

Definition at line 59 of file PDESolver.hpp.

void raise_iteration_done ( )

protected

raises the event when iteration done

Definition at line 246 of file PDESolver.cpp.

void set_time_step_computer ( )

private

Definition at line 107 of file PDESolver.cpp.

virtual void setup ( )

inlinevirtual

Definition at line 63 of file PDESolver.hpp.

void signal_solve_iterations ( common::SignalArgs & args )

Definition at line 271 of file PDESolver.cpp.

void signal_solve_time_step ( common::SignalArgs & args )

Definition at line 257 of file PDESolver.cpp.

void signature_solve_iterations ( common::SignalArgs & args )

Definition at line 277 of file PDESolver.cpp.

void signature_solve_time_step ( common::SignalArgs & args )

Definition at line 263 of file PDESolver.cpp.

void solve_iterations ( const Uint nb_iterations )

Definition at line 194 of file PDESolver.cpp.

void solve_time_step ( const Real time_step )

Definition at line 184 of file PDESolver.cpp.

virtual void step ( )

pure virtual

bool stop_condition ( )

Definition at line 135 of file PDESolver.cpp.

const Handle<solver::TimeStepComputer> time_step_computer ( )

inline

Definition at line 77 of file PDESolver.hpp.

static std::string type_name ( )

inlinestatic

Get the class name.

Definition at line 55 of file PDESolver.hpp.

Member Data Documentation

Handle<common::ActionDirector> m_function

protected

Definition at line 117 of file PDESolver.hpp.

Handle< solver::History > m_history

protected

Component tracking history of several variables.

Definition at line 122 of file PDESolver.hpp.

Handle< solver::ComputeLNorm > m_norm_computer

protected

Definition at line 124 of file PDESolver.hpp.

Handle<solver::PDE> m_pde

protected

Definition at line 106 of file PDESolver.hpp.

Handle<common::ActionDirector> m_post_iteration

protected

set of actions called every iteration after non-linear solve

Definition at line 113 of file PDESolver.hpp.

Handle<common::ActionDirector> m_post_update

protected

Definition at line 120 of file PDESolver.hpp.

Handle<common::ActionDirector> m_pre_iteration

protected

set of actions called every iteration before non-linear solve

Definition at line 111 of file PDESolver.hpp.

Handle<common::ActionDirector> m_pre_update

protected

Definition at line 119 of file PDESolver.hpp.

Handle<common::ActionDirector> m_prepare_function

protected

Definition at line 115 of file PDESolver.hpp.

Handle<solver::TimeStepComputer> m_time_step_computer

protected

Definition at line 108 of file PDESolver.hpp.

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

cf3/solver/PDESolver.hpp
cf3/solver/PDESolver.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation