ug::d3f::th_sss_data< dim > Class Template Reference

class for data for all the thermohaline flow sources and sinks More...

#include <d3f_sss.h>

Inheritance diagram for ug::d3f::th_sss_data< dim >:

Public Member Functions
void	compute (const MathVector< dim > &x, number time, int si)
	computes the data from the user data object
number	concentration ()
	returns the concentration
number	intensity ()
	returns the intensity
void	set (LuaFunctionHandle func)
	set as a LUA function
void	set (number intens, number c, number T)
	sets the data
void	set (SmartPtr< UserData< MathVector< 3 >, dim > > spData)
	sets the data by an object
number	temperature ()
	returns the temperature
	th_sss_data ()
	class construction (there must exist a 'dummy' constructor!)

Private Attributes
SmartPtr< UserData< MathVector< 3 >, dim > >	m_spData
	an alternative method to specify the data
MathVector< 3 >	m_values

Detailed Description

template<int dim>
class ug::d3f::th_sss_data< dim >

class for data for all the thermohaline flow sources and sinks

Constructor & Destructor Documentation

th_sss_data()

template<int dim>

ug::d3f::th_sss_data< dim >::th_sss_data ( )

inline

class construction (there must exist a 'dummy' constructor!)

References ug::d3f::th_sss_data< dim >::m_values.

Member Function Documentation

compute()

template<int dim>

void ug::d3f::th_sss_data< dim >::compute ( const MathVector< dim > &  x, number  time, int  si  )

inline

computes the data from the user data object

Parameters

x	point where to evaluate
time	time argument for the evaluation
si	subset where to evaluate

References ug::d3f::th_sss_data< dim >::m_spData, and ug::d3f::th_sss_data< dim >::m_values.

concentration()

template<int dim>

number ug::d3f::th_sss_data< dim >::concentration ( )

inline

returns the concentration

References ug::d3f::th_sss_data< dim >::m_values.

intensity()

template<int dim>

number ug::d3f::th_sss_data< dim >::intensity ( )

inline

returns the intensity

References ug::d3f::th_sss_data< dim >::m_values.

set() [1/3]

template<int dim>

void ug::d3f::th_sss_data< dim >::set ( LuaFunctionHandle  func )

inline

set as a LUA function

References ug::d3f::th_sss_data< dim >::m_spData, and make_sp().

set() [2/3]

template<int dim>

void ug::d3f::th_sss_data< dim >::set ( number  intens, number  c, number  T  )

inline

sets the data

References ug::d3f::th_sss_data< dim >::m_spData, ug::d3f::th_sss_data< dim >::m_values, and SPNULL.

set() [3/3]

template<int dim>

void ug::d3f::th_sss_data< dim >::set ( SmartPtr< UserData< MathVector< 3 >, dim > >  spData )

inline

sets the data by an object

References ug::d3f::th_sss_data< dim >::m_spData.

temperature()

template<int dim>

number ug::d3f::th_sss_data< dim >::temperature ( )

inline

returns the temperature

References ug::d3f::th_sss_data< dim >::m_values.

Member Data Documentation

m_spData

template<int dim>

SmartPtr<UserData<MathVector<3>, dim> > ug::d3f::th_sss_data< dim >::m_spData

private

an alternative method to specify the data

Referenced by ug::d3f::th_sss_data< dim >::compute(), ug::d3f::th_sss_data< dim >::set(), ug::d3f::th_sss_data< dim >::set(), and ug::d3f::th_sss_data< dim >::set().

m_values

template<int dim>

MathVector<3> ug::d3f::th_sss_data< dim >::m_values

private

the data for the source/sink: [0]: total liquid phase flux through the point [1]: concentration of the salt in the source (used only if intensity > 0) [2]: temperature of the salt in the source (used only if intensity > 0)

Referenced by ug::d3f::th_sss_data< dim >::compute(), ug::d3f::th_sss_data< dim >::concentration(), ug::d3f::th_sss_data< dim >::intensity(), ug::d3f::th_sss_data< dim >::set(), ug::d3f::th_sss_data< dim >::temperature(), and ug::d3f::th_sss_data< dim >::th_sss_data().

---

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

• /home/runner/work/docs/docs/ug4/plugins/d3f/d3f_sss.h