ug::Richards::Functionality Struct Reference

Static Public Member Functions
template<typename T , int dim>
static void	add_user_data (const char *idstring, Registry &reg, const string grp, const string suffix, const string tag)
template<typename TAlgebra >
static void	Algebra (Registry &reg, string grp)
static void	Common (Registry &reg, string grp)
template<int dim>
static void	Dimension (Registry &reg, string grp)
template<typename TDomain >
static void	Domain (Registry &reg, string grp)
template<typename TDomain , typename TAlgebra >
static void	DomainAlgebra (Registry &reg, string grp)

Detailed Description

Class exporting the functionality of the plugin. All functionality that is to be used in scripts or visualization must be registered here.

Member Function Documentation

add_user_data()

template<typename T , int dim>

static void ug::Richards::Functionality::add_user_data ( const char *  idstring, Registry &  reg, const string  grp, const string  suffix, const string  tag  )

inlinestatic

Function called for the registration of Dimension dependent parts of the plugin. All Functions and Classes depending on the Dimension are to be placed here when registering. The method is called for all available Dimension types, based on the current build options.

Parameters

reg	registry
parentGroup	group for sorting of functionality

References ug::bridge::Registry::add_class_(), and ug::bridge::Registry::add_class_to_group().

Algebra()

template<typename TAlgebra >

static void ug::Richards::Functionality::Algebra ( Registry &  reg, string  grp  )

inlinestatic

Function called for the registration of Algebra dependent parts of the plugin. All Functions and Classes depending on Algebra are to be placed here when registering. The method is called for all available Algebra types, based on the current build options.

Parameters

reg	registry
parentGroup	group for sorting of functionality

Common()

static void ug::Richards::Functionality::Common ( Registry &  reg, string  grp  )

inlinestatic

Function called for the registration of Domain and Algebra independent parts of the plugin. All Functions and Classes not depending on Domain and Algebra are to be placed here when registering.

Parameters

reg	registry
parentGroup	group for sorting of functionality

References ug::bridge::Registry::add_class_(), and ug::bridge::Registry::add_function().

Dimension()

template<int dim>

static void ug::Richards::Functionality::Dimension ( Registry &  reg, string  grp  )

inlinestatic

References ug::bridge::Registry::add_class_(), and ug::bridge::Registry::add_class_to_group().

Domain()

template<typename TDomain >

static void ug::Richards::Functionality::Domain ( Registry &  reg, string  grp  )

inlinestatic

Function called for the registration of Domain dependent parts of the plugin. All Functions and Classes depending on the Domain are to be placed here when registering. The method is called for all available Domain types, based on the current build options.

Parameters

reg	registry
parentGroup	group for sorting of functionality

References ug::bridge::Registry::add_class_(), ug::bridge::Registry::add_class_to_group(), and ug::bridge::Registry::add_function().

DomainAlgebra()

template<typename TDomain , typename TAlgebra >

static void ug::Richards::Functionality::DomainAlgebra ( Registry &  reg, string  grp  )

inlinestatic

Function called for the registration of Domain and Algebra dependent parts of the plugin. All Functions and Classes depending on both Domain and Algebra are to be placed here when registering. The method is called for all available Domain and Algebra types, based on the current build options.

Parameters

reg	registry
parentGroup	group for sorting of functionality

---

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

• /home/runner/work/docs/docs/ug4/plugins/Richards/richards_plugin.cpp