Kaskade::VariableDescription< spaceId, components, Id > Struct Template Reference

A class storing elementary information about a single variable.This includes the number of components, the id and name of the variable, and the index of the associated FEFunctionSpace from which the variable comes. More...

#include <variables.hh>

Detailed Description

template<int spaceId, int components, int Id = -1>
struct Kaskade::VariableDescription< spaceId, components, Id >

A class storing elementary information about a single variable.

This includes the number of components, the id and name of the variable, and the index of the associated FEFunctionSpace from which the variable comes.

Template Parameters

spaceId	the index of the FEFunctionSpace to which the variable belongs. This references an external container of FE spaces.
components	the number of components that this variable has (1 indicates a scalar variable, values greater than 1 a vectorial variable). Has to be greater than 0.
Id	the index of the variable by which it can be retrieved from a boost::fusion container of variables.

Note that the order of template parameters is important. A more convenient interface is provided by Variable, where the order of template parameters can be arbitrary.

Definition at line 75 of file variables.hh.

Static Public Attributes
static int const	id = Id
	number of this variable More...
static int const	m = components
	number of component of this variable More...
static int const	spaceIndex = spaceId
	number of the space, this variable is associated with More...

Member Data Documentation

id

template<int spaceId, int components, int Id = -1>

int const Kaskade::VariableDescription< spaceId, components, Id >::id = Id

static

number of this variable

Definition at line 78 of file variables.hh.

m

template<int spaceId, int components, int Id = -1>

int const Kaskade::VariableDescription< spaceId, components, Id >::m = components

static

number of component of this variable

Definition at line 80 of file variables.hh.

spaceIndex

template<int spaceId, int components, int Id = -1>

int const Kaskade::VariableDescription< spaceId, components, Id >::spaceIndex = spaceId

static

number of the space, this variable is associated with

Definition at line 82 of file variables.hh.

---

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

• variables.hh