branch - a parameter-dependent sequence of field More...

#include <branch.h>

Inherits std::vector< T >.

Public Types
typedef std::vector< std::pair < std::string, field_basic< T, M > > >	base
typedef base::size_type	size_type

Public Member Functions
	branch_basic ()
	branch_basic (const std::string &parameter_name, const std::string &u0)
	branch_basic (const std::string &parameter_name, const std::string &u0, const std::string &u1)
	~branch_basic ()
const T &	parameter () const
const std::string &	parameter_name () const
size_type	n_value () const
size_type	n_field () const
void	set_parameter_name (const std::string &name)
void	set_parameter (const T &value)
void	set_range (const std::pair< T, T > &u_range)
__obranch< T, M >	operator() (const T &t, const field_basic< T, M > &u0)
__obranch< T, M >	operator() (const T &t, const field_basic< T, M > &u0, const field_basic< T, M > &u1)
__iobranch< T, M >	operator() (T &t, field_basic< T, M > &u0)
__iobranch< T, M >	operator() (T &t, field_basic< T, M > &u0, field_basic< T, M > &u1)
__branch_header< T, M >	header ()
__const_branch_header< T, M >	header () const
__const_branch_finalize< T, M >	finalize () const
void	put_header (odiststream &) const
void	get_header (idiststream &)
void	put_finalize (odiststream &) const
void	put_header_rheolef (odiststream &) const
void	put_event_rheolef (odiststream &) const
void	put_header_vtk (odiststream &) const
void	put_geometry_vtk (odiststream &) const
void	put_event_vtk (odiststream &) const
void	put_finalize_vtk (odiststream &) const
void	put_header_paraview (odiststream &) const
void	put_event_paraview (odiststream &) const
void	put_finalize_paraview (odiststream &) const

Protected Attributes
std::string	_parameter_name
T	_parameter_value
size_type	_n_value
size_type	_count_value
std::ostream *	_p_data_out
std::ostream *	_p_ctrl_out
bool	_header_in_done
bool	_header_out_done
bool	_finalize_out_done
std::pair< T, T >	_u_range

Friends
class	__obranch
class	__iobranch
template<class T1 , class M1 >
idiststream &	operator>> (idiststream &, branch_basic< T1, M1 > &)
template<class T1 , class M1 >
odiststream &	operator<< (odiststream &, const branch_basic< T1, M1 > &)
template<class T1 >
void	put_header (odiststream &, const branch_basic< T1, sequential > &)
template<class T1 >
void	put_event (odiststream &, const branch_basic< T1, sequential > &)
template<class T1 >
void	put_finalize (odiststream &, const branch_basic< T1, sequential > &)
template<class T1 >
void	put_header (odiststream &, const branch_basic< T1, distributed > &)
template<class T1 >
void	put_event (odiststream &, const branch_basic< T1, distributed > &)
template<class T1 >
void	put_finalize (odiststream &, const branch_basic< T1, distributed > &)
template<class T1 >
void	put_header_gnuplot (odiststream &, const branch_basic< T1, sequential > &)
template<class T1 >
void	put_event_gnuplot (odiststream &, const branch_basic< T1, sequential > &)
template<class T1 >
void	put_finalize_gnuplot (odiststream &, const branch_basic< T1, sequential > &)
template<class T1 >
void	put_header_paraview (odiststream &, const branch_basic< T1, sequential > &)
template<class T1 >
void	put_event_paraview (odiststream &, const branch_basic< T1, sequential > &)
template<class T1 >
void	put_finalize_paraview (odiststream &, const branch_basic< T1, sequential > &)

Additional Inherited Members
Public Attributes inherited from std::vector< T >
T	elements
	STL member.

Detailed Description

template<class T, class M = rheo_default_memory_model>
class rheolef::branch_basic< T, M >

branch - a parameter-dependent sequence of field

Stores a field sequence together with its associated parameter value: a branch variable represents a pair (t,uh(t)) for a specific value of the parameter t. Applications concern time-dependent problems and continuation methods.

This class is convenient for file inputs/outputs and building graphical animations.

EXAMPLES

Coming soon...

LIMITATIONS

This class is under development.

The branch class store pointers on field class without reference counting. Thus, branch automatic variables cannot be returned by functions. branch variable are limited to local variables.

Definition at line 45 of file branch.h.

Member Typedef Documentation

template<class T, class M = rheo_default_memory_model>

typedef std::vector<std::pair<std::string,field_basic<T,M> > > rheolef::branch_basic< T, M >::base

Definition at line 48 of file branch.h.

template<class T, class M = rheo_default_memory_model>

typedef base::size_type rheolef::branch_basic< T, M >::size_type

Definition at line 49 of file branch.h.

Constructor & Destructor Documentation

template<class T , class M >

rheolef::branch_basic< T, M >::branch_basic ( )

inline

Definition at line 146 of file branch.h.

template<class T , class M >

rheolef::branch_basic< T, M >::branch_basic	(	const std::string &	parameter_name,
		const std::string &	u0
	)

inline

Definition at line 163 of file branch.h.

template<class T , class M >

rheolef::branch_basic< T, M >::branch_basic	(	const std::string &	parameter_name,
		const std::string &	u0,
		const std::string &	u1
	)

inline

Definition at line 183 of file branch.h.

template<class T , class M >

rheolef::branch_basic< T, M >::~branch_basic ( )

Definition at line 6 of file branch.cc.

Member Function Documentation

template<class T , class M >

const T & rheolef::branch_basic< T, M >::parameter ( ) const

inline

Definition at line 206 of file branch.h.

template<class T , class M >

const std::string & rheolef::branch_basic< T, M >::parameter_name ( ) const

inline

Definition at line 213 of file branch.h.

template<class T , class M >

branch_basic< T, M >::size_type rheolef::branch_basic< T, M >::n_value ( ) const

inline

Definition at line 220 of file branch.h.

template<class T , class M >

branch_basic< T, M >::size_type rheolef::branch_basic< T, M >::n_field ( ) const

inline

Definition at line 227 of file branch.h.

template<class T , class M >

void rheolef::branch_basic< T, M >::set_parameter_name ( const std::string & name )

inline

Definition at line 234 of file branch.h.

template<class T , class M >

void rheolef::branch_basic< T, M >::set_parameter ( const T & value )

inline

Definition at line 241 of file branch.h.

template<class T , class M >

void rheolef::branch_basic< T, M >::set_range ( const std::pair< T, T > & u_range )

inline

Definition at line 248 of file branch.h.

template<class T , class M >

__obranch< T, M > rheolef::branch_basic< T, M >::operator()	(	const T &	t,
		const field_basic< T, M > &	u0
	)

inline

Definition at line 355 of file branch.h.

template<class T , class M >

__obranch< T, M > rheolef::branch_basic< T, M >::operator()	(	const T &	t,
		const field_basic< T, M > &	u0,
		const field_basic< T, M > &	u1
	)

inline

Definition at line 377 of file branch.h.

template<class T , class M >

__iobranch< T, M > rheolef::branch_basic< T, M >::operator()	(	T &	t,
		field_basic< T, M > &	u0
	)

inline

Definition at line 366 of file branch.h.

template<class T , class M >

__iobranch< T, M > rheolef::branch_basic< T, M >::operator()	(	T &	t,
		field_basic< T, M > &	u0,
		field_basic< T, M > &	u1
	)

inline

Definition at line 389 of file branch.h.

template<class T , class M >

__branch_header< T, M > rheolef::branch_basic< T, M >::header ( )

inline

Definition at line 277 of file branch.h.

template<class T , class M >

__const_branch_header< T, M > rheolef::branch_basic< T, M >::header ( ) const

inline

Definition at line 284 of file branch.h.

template<class T , class M >

__const_branch_finalize< T, M > rheolef::branch_basic< T, M >::finalize ( ) const

inline

Definition at line 300 of file branch.h.

template<class T , class M >

void rheolef::branch_basic< T, M >::put_header ( odiststream & out ) const

Definition at line 51 of file branch.cc.

template<class T , class M >

void rheolef::branch_basic< T, M >::get_header ( idiststream & in )

Definition at line 59 of file branch.cc.

template<class T , class M >

void rheolef::branch_basic< T, M >::put_finalize ( odiststream & out ) const

Definition at line 163 of file branch.cc.

template<class T , class M >

void rheolef::branch_basic< T, M >::put_header_rheolef ( odiststream & out ) const

Definition at line 13 of file branch.cc.

template<class T , class M >

void rheolef::branch_basic< T, M >::put_event_rheolef ( odiststream & out ) const

Definition at line 100 of file branch.cc.

template<class T, class M = rheo_default_memory_model>

void rheolef::branch_basic< T, M >::put_header_vtk ( odiststream & ) const

template<class T, class M = rheo_default_memory_model>

void rheolef::branch_basic< T, M >::put_geometry_vtk ( odiststream & ) const

template<class T, class M = rheo_default_memory_model>

void rheolef::branch_basic< T, M >::put_event_vtk ( odiststream & ) const

template<class T, class M = rheo_default_memory_model>

void rheolef::branch_basic< T, M >::put_finalize_vtk ( odiststream & ) const

template<class T, class M = rheo_default_memory_model>

void rheolef::branch_basic< T, M >::put_header_paraview ( odiststream & ) const

template<class T, class M = rheo_default_memory_model>

void rheolef::branch_basic< T, M >::put_event_paraview ( odiststream & ) const

template<class T, class M = rheo_default_memory_model>

void rheolef::branch_basic< T, M >::put_finalize_paraview ( odiststream & ) const

Friends And Related Function Documentation

template<class T, class M = rheo_default_memory_model>

friend class __obranch

friend

Definition at line 92 of file branch.h.

template<class T, class M = rheo_default_memory_model>

friend class __iobranch

friend

Definition at line 93 of file branch.h.

template<class T, class M = rheo_default_memory_model>

template<class T1 , class M1 >

idiststream& operator>>	(	idiststream &	,
		branch_basic< T1, M1 > &
	)

friend

template<class T, class M = rheo_default_memory_model>

template<class T1 , class M1 >

odiststream& operator<<	(	odiststream &	,
		const branch_basic< T1, M1 > &
	)

friend

template<class T, class M = rheo_default_memory_model>

template<class T1 >

void put_header	(	odiststream &	,
		const branch_basic< T1, sequential > &
	)

friend

template<class T, class M = rheo_default_memory_model>

template<class T1 >

void put_event	(	odiststream &	,
		const branch_basic< T1, sequential > &
	)

friend

template<class T, class M = rheo_default_memory_model>

template<class T1 >

void put_finalize	(	odiststream &	,
		const branch_basic< T1, sequential > &
	)

friend

template<class T, class M = rheo_default_memory_model>

template<class T1 >

void put_header	(	odiststream &	,
		const branch_basic< T1, distributed > &
	)

friend

template<class T, class M = rheo_default_memory_model>

template<class T1 >

void put_event	(	odiststream &	,
		const branch_basic< T1, distributed > &
	)

friend

template<class T, class M = rheo_default_memory_model>

template<class T1 >

void put_finalize	(	odiststream &	,
		const branch_basic< T1, distributed > &
	)

friend

template<class T, class M = rheo_default_memory_model>

template<class T1 >

void put_header_gnuplot	(	odiststream &	,
		const branch_basic< T1, sequential > &
	)

friend

template<class T, class M = rheo_default_memory_model>

template<class T1 >

void put_event_gnuplot	(	odiststream &	,
		const branch_basic< T1, sequential > &
	)

friend

template<class T, class M = rheo_default_memory_model>

template<class T1 >

void put_finalize_gnuplot	(	odiststream &	,
		const branch_basic< T1, sequential > &
	)

friend

template<class T, class M = rheo_default_memory_model>

template<class T1 >

void put_header_paraview	(	odiststream &	,
		const branch_basic< T1, sequential > &
	)

friend

template<class T, class M = rheo_default_memory_model>

template<class T1 >

void put_event_paraview	(	odiststream &	,
		const branch_basic< T1, sequential > &
	)

friend

template<class T, class M = rheo_default_memory_model>

template<class T1 >

void put_finalize_paraview	(	odiststream &	,
		const branch_basic< T1, sequential > &
	)

friend

Member Data Documentation

template<class T, class M = rheo_default_memory_model>

std::string rheolef::branch_basic< T, M >::_parameter_name

protected

Definition at line 125 of file branch.h.

template<class T, class M = rheo_default_memory_model>

T rheolef::branch_basic< T, M >::_parameter_value

protected

Definition at line 126 of file branch.h.

template<class T, class M = rheo_default_memory_model>

size_type rheolef::branch_basic< T, M >::_n_value

protected

Definition at line 127 of file branch.h.

template<class T, class M = rheo_default_memory_model>

size_type rheolef::branch_basic< T, M >::_count_value

mutableprotected

Definition at line 128 of file branch.h.

template<class T, class M = rheo_default_memory_model>

std::ostream* rheolef::branch_basic< T, M >::_p_data_out

mutableprotected

Definition at line 129 of file branch.h.

template<class T, class M = rheo_default_memory_model>

std::ostream* rheolef::branch_basic< T, M >::_p_ctrl_out

mutableprotected

Definition at line 130 of file branch.h.

template<class T, class M = rheo_default_memory_model>

bool rheolef::branch_basic< T, M >::_header_in_done

mutableprotected

Definition at line 131 of file branch.h.

template<class T, class M = rheo_default_memory_model>

bool rheolef::branch_basic< T, M >::_header_out_done

mutableprotected

Definition at line 132 of file branch.h.

template<class T, class M = rheo_default_memory_model>

bool rheolef::branch_basic< T, M >::_finalize_out_done

mutableprotected

Definition at line 133 of file branch.h.

template<class T, class M = rheo_default_memory_model>

std::pair<T,T> rheolef::branch_basic< T, M >::_u_range

protected

Definition at line 134 of file branch.h.

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

Public Types

Public Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

template<class T, class M = rheo_default_memory_model> class rheolef::branch_basic< T, M >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation

template<class T, class M = rheo_default_memory_model>
class rheolef::branch_basic< T, M >