ug::ConvectionDiffusionPlugin::cd_sss_data< dim > Class Template Reference

class for data for all the CD plugin sources and sinks More...

#include <convection_diffusion_sss.h>

Inheritance diagram for ug::ConvectionDiffusionPlugin::cd_sss_data< dim >:

Public Types
typedef SmartPtr< CplUserData< number, dim > >	user_data_type

Public Member Functions
	cd_sss_data ()
	class construction (there must exist a 'dummy' constructor!) More...
void	compute (const MathVector< dim > &x, number time, int si)
	computes the data from the user data object More...
number	flux ()
	returns the flux More...
void	set (number flux)
	sets the data More...
void	set (user_data_type spData)
	sets the data by an object More...

Protected Attributes
user_data_type	m_spData
	an alternative method to specify the data More...
number	m_values

Detailed Description

template<int dim>
class ug::ConvectionDiffusionPlugin::cd_sss_data< dim >

class for data for all the CD plugin sources and sinks

Member Typedef Documentation

user_data_type

template<int dim>

typedef SmartPtr<CplUserData<number, dim> > ug::ConvectionDiffusionPlugin::cd_sss_data< dim >::user_data_type

Constructor & Destructor Documentation

cd_sss_data()

template<int dim>

ug::ConvectionDiffusionPlugin::cd_sss_data< dim >::cd_sss_data ( )

inline

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

References ug::ConvectionDiffusionPlugin::cd_sss_data< dim >::m_values.

Member Function Documentation

compute()

template<int dim>

void ug::ConvectionDiffusionPlugin::cd_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::ConvectionDiffusionPlugin::cd_sss_data< dim >::m_spData, ug::ConvectionDiffusionPlugin::cd_sss_data< dim >::m_values, and SmartPtr< class, FreePolicy >::valid().

flux()

template<int dim>

number ug::ConvectionDiffusionPlugin::cd_sss_data< dim >::flux ( )

inline

returns the flux

References ug::ConvectionDiffusionPlugin::cd_sss_data< dim >::m_values.

Referenced by ug::ConvectionDiffusionPlugin::cd_sss_data< dim >::set().

set() [1/2]

template<int dim>

void ug::ConvectionDiffusionPlugin::cd_sss_data< dim >::set ( number  flux )

inline

sets the data

References ug::ConvectionDiffusionPlugin::cd_sss_data< dim >::flux(), ug::ConvectionDiffusionPlugin::cd_sss_data< dim >::m_spData, ug::ConvectionDiffusionPlugin::cd_sss_data< dim >::m_values, and SPNULL.

set() [2/2]

template<int dim>

void ug::ConvectionDiffusionPlugin::cd_sss_data< dim >::set ( user_data_type  spData )

inline

sets the data by an object

References ug::ConvectionDiffusionPlugin::cd_sss_data< dim >::m_spData.

Member Data Documentation

m_spData

template<int dim>

user_data_type ug::ConvectionDiffusionPlugin::cd_sss_data< dim >::m_spData

protected

an alternative method to specify the data

Referenced by ug::ConvectionDiffusionPlugin::cd_sss_data< dim >::compute(), and ug::ConvectionDiffusionPlugin::cd_sss_data< dim >::set().

m_values

template<int dim>

number ug::ConvectionDiffusionPlugin::cd_sss_data< dim >::m_values

protected

the data for the source/sink: [0]: total contaminant flux through the point

Referenced by ug::ConvectionDiffusionPlugin::cd_sss_data< dim >::cd_sss_data(), ug::ConvectionDiffusionPlugin::cd_sss_data< dim >::compute(), ug::ConvectionDiffusionPlugin::cd_sss_data< dim >::flux(), and ug::ConvectionDiffusionPlugin::cd_sss_data< dim >::set().

---

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

• /home/runner/work/docs/docs/ug4/plugins/ConvectionDiffusion/convection_diffusion_sss.h