disc_import_param< T > Class Template Reference

Base class for the import parameters of discretization modules. More...

#include <CoupledDisc.hpp>

Collaboration diagram for disc_import_param< T >:

[legend]List of all members.

Public Types
enum	connection_type { UNUSED = 0, CONSTANT = 1, LINKED = 2, CONNECTED = 3 }
Public Member Functions
virtual void	PrintParam ()
	Prints the name and parameters of the export parameter.
void	connect (disc_export_param< T > &exp_param)
	Connects 'this' parameter with an export parameter.
void	link (disc_export_param< T > &exp_param)
	Connects 'this' parameter with an export parameter so that the derivatives are ignored when assembling the Jacobian.
void	set_value (T *the_value)
	Sets a constant value to the parameter.
void	compute_value (MultiIndex &index, GridVec< T > &u)
	Computes the value of the connected export parameter (if 'this' parameter is not connected, the function does nothing).
	disc_import_param (T *the_value_ptr, int the_value_sz=1)
	Constructor.
virtual	~disc_import_param ()
	Virtual destructor.
Public Attributes
enum disc_import_param::connection_type	used
disc_export_param< T > *	export_param_ptr
Array< bool >	position
int	value_sz
T *	value_ptr

---

Detailed Description

template<typename T>
class disc_import_param< T >

Base class for the import parameters of discretization modules.

---

Member Enumeration Documentation

template<typename T>

enum disc_import_param::connection_type

Enumerator:

UNUSED
CONSTANT
LINKED
CONNECTED

---

Constructor & Destructor Documentation

template<typename T>

disc_import_param< T >::disc_import_param	(	T *	the_value_ptr,
		int	the_value_sz = 1
	)			[inline]

Constructor.

Parameters:

[in]	the_value_ptr	Buffer for the value
[in]	the_value_sz	Size of the value

Note:

Do not forget to initialize 'position'!

template<typename T>

virtual disc_import_param< T >::~disc_import_param

(

)

[inline, virtual]

Virtual destructor.

---

Member Function Documentation

template<typename T>

virtual void disc_import_param< T >::PrintParam

(

)

[inline, virtual]

Prints the name and parameters of the export parameter.

template<typename T>

void disc_import_param< T >::connect

(

disc_export_param< T > &

exp_param

)

[inline]

Connects 'this' parameter with an export parameter.

Parameters:

[in]

exp_param

The export parameter

template<typename T>

void disc_import_param< T >::link

(

disc_export_param< T > &

exp_param

)

[inline]

Connects 'this' parameter with an export parameter so that the derivatives are ignored when assembling the Jacobian.

Parameters:

[in]

exp_param

The export parameter

template<typename T>

void disc_import_param< T >::set_value

(

T *

the_value

)

[inline]

Sets a constant value to the parameter.

Parameters:

[in]

the_value

Array of the values to set

template<typename T>

void disc_import_param< T >::compute_value	(	MultiIndex &	index,
		GridVec< T > &	u
	)			[inline]

Computes the value of the connected export parameter (if 'this' parameter is not connected, the function does nothing).

Parameters:

[in]	index	Index of the grid point
[in]	u	Guess of the solution

---

Member Data Documentation

template<typename T>

enum disc_import_param::connection_type disc_import_param< T >::used

type of the current connection

template<typename T>

disc_export_param<T>* disc_import_param< T >::export_param_ptr

ptr. to the connected export param.

template<typename T>

Array<bool> disc_import_param< T >::position

position of the parameter's grid points

template<typename T>

int disc_import_param< T >::value_sz

length of the value (in T-units)

template<typename T>

T* disc_import_param< T >::value_ptr

pointer to the array where the value should be saved

---

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

• CoupledDisc.hpp

---