Time Stepping component. More...

#include <TimeStepping.hpp>

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

virtual	~TimeStepping ()

virtual void	do_step ()
	do a step More...

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

common::ActionDirector &	pre_actions ()
	Actions to execute before the time step. More...

common::ActionDirector &	post_actions ()
	Actions to execute after the time step. More...

const Handle< solver::History > &	history ()
	Access to the history. More...

void	add_time (const Handle< solver::Time > &time)

bool	finished ()

bool	not_finished ()

void	signal_do_step (common::SignalArgs &args)
	Do a step. 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...

Private Member Functions
void	config_end_time ()
	configure end_time in the m_time component More...

void	config_time_step ()
	configure time_step in the m_time component More...

bool	stop_condition ()

void	raise_timestep_done ()
	raises event when timestep is done More...

Private Attributes
std::vector< Handle< solver::Time > >	m_times
	component tracking time More...

Handle< common::ActionDirector >	m_pre_actions
	set of actions before non-linear solve More...

Handle< common::ActionDirector >	m_post_actions
	set of actions after non-linear solve More...

Handle< solver::History >	m_history
	Component tracking history of several variables. 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...

Public Attributes inherited from SignalHandler
storage_t	m_signals
	storage of the signals 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...

Detailed Description

Time Stepping component.

Author: Willem Deconinck This component needs to have configured a end_time, and a time_step It then executes exactly as many time-steps necessary to reach the end_time with the given time_step.
pre_actions() and post_actions() hooks are available to perform actions before and after the time-step execution.
A history file by default called "timestepping.tsv" is written every step, containing timing and memory information per step. This information is also given in the info stream.

Definition at line 31 of file TimeStepping.hpp.

Constructor & Destructor Documentation

TimeStepping ( const std::string & name )

Contructor

Parameters

name	of the component

Definition at line 49 of file TimeStepping.cpp.

virtual ~TimeStepping ( )

inlinevirtual

Definition at line 40 of file TimeStepping.hpp.

Member Function Documentation

void add_time ( const Handle< solver::Time > & time )

Definition at line 137 of file TimeStepping.cpp.

void config_end_time ( )

private

configure end_time in the m_time component

Definition at line 109 of file TimeStepping.cpp.

void config_time_step ( )

private

configure time_step in the m_time component

Definition at line 126 of file TimeStepping.cpp.

void do_step ( )

virtual

do a step

Postcondition: property "finished" is assigned to true if no more steps are to be made

(1) the pre actions - pre-process, user defined actions, etc

(2) the registered actions that solve one time step

(3) advance time & iteration

(4) the post actions - compute norm, post-process something, etc

(5) raise event of time_step done

(6) Statistics

(7) Write history

(8) Output info

Definition at line 195 of file TimeStepping.cpp.

void execute ( )

virtual

Execute all active child actions.

Reimplemented from ActionDirector.

Definition at line 184 of file TimeStepping.cpp.

bool finished ( )

Definition at line 144 of file TimeStepping.cpp.

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

inline

Access to the history.

Definition at line 60 of file TimeStepping.hpp.

bool not_finished ( )

Definition at line 149 of file TimeStepping.cpp.

common::ActionDirector& post_actions ( )

inline

Actions to execute after the time step.

Definition at line 57 of file TimeStepping.hpp.

common::ActionDirector& pre_actions ( )

inline

Actions to execute before the time step.

Definition at line 54 of file TimeStepping.hpp.

void raise_timestep_done ( )

private

raises event when timestep is done

Definition at line 278 of file TimeStepping.cpp.

void signal_do_step ( common::SignalArgs & args )

Do a step.

Definition at line 293 of file TimeStepping.cpp.

bool stop_condition ( )

private

Returns: true if any of the stop criteria is achieved

Definition at line 156 of file TimeStepping.cpp.

static std::string type_name ( )

inlinestatic

Get the class name.

Definition at line 43 of file TimeStepping.hpp.

Member Data Documentation

Handle< solver::History > m_history

private

Component tracking history of several variables.

Definition at line 91 of file TimeStepping.hpp.

Handle< common::ActionDirector > m_post_actions

private

set of actions after non-linear solve

Definition at line 90 of file TimeStepping.hpp.

Handle< common::ActionDirector > m_pre_actions

private

set of actions before non-linear solve

Definition at line 89 of file TimeStepping.hpp.

std::vector< Handle< solver::Time > > m_times

private

component tracking time

Definition at line 88 of file TimeStepping.hpp.

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

cf3/solver/TimeStepping.hpp
cf3/solver/TimeStepping.cpp

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation