aspect::FEVariable< dim > Struct Template Reference

Inheritance diagram for aspect::FEVariable< dim >:

Public Member Functions
	FEVariable (const VariableDeclaration< dim > &fe_variable, const unsigned int component_index, const unsigned int block_index, const unsigned int base_index)
const FEValuesExtractors::Scalar &	extractor_scalar () const
const FEValuesExtractors::Vector &	extractor_vector () const
Public Member Functions inherited from aspect::VariableDeclaration< dim >
	VariableDeclaration (const std::string &name, const std::shared_ptr< FiniteElement< dim >> &fe, const unsigned int multiplicity, const unsigned int n_blocks)
	VariableDeclaration ()
unsigned int	n_components () const

Public Attributes
unsigned int	first_component_index
unsigned int	block_index
unsigned int	base_index
ComponentMask	component_mask
Public Attributes inherited from aspect::VariableDeclaration< dim >
std::string	name
std::shared_ptr< FiniteElement< dim > >	fe
unsigned int	multiplicity
unsigned int	n_blocks

Private Attributes
FEValuesExtractors::Scalar	scalar_extractor
FEValuesExtractors::Vector	vector_extractor

Detailed Description

template<int dim>
struct aspect::FEVariable< dim >

Struct to represent a variable as part of a FEVariableCollection. Constructed from an instance of VariableDeclaration<dim> but contains additional information that can be queried.

Definition at line 111 of file fe_variable_collection.h.

Constructor & Destructor Documentation

FEVariable()

template<int dim>

aspect::FEVariable< dim >::FEVariable	(	const VariableDeclaration< dim > &	fe_variable,
		const unsigned int	component_index,
		const unsigned int	block_index,
		const unsigned int	base_index
	)

Initialize this variable as part of a FESystem with the given indices for component, block, and base.

Member Function Documentation

extractor_scalar()

template<int dim>

const FEValuesExtractors::Scalar& aspect::FEVariable< dim >::extractor_scalar

(

)

const

Return a scalar FeValuesExtractor if this variable is scalar.

extractor_vector()

template<int dim>

const FEValuesExtractors::Vector& aspect::FEVariable< dim >::extractor_vector

(

)

const

Return a vector FeValuesExtractor if this variable is a vector.

Member Data Documentation

first_component_index

template<int dim>

unsigned int aspect::FEVariable< dim >::first_component_index

The first component index of this variable within the FEVariableCollection.

Definition at line 126 of file fe_variable_collection.h.

block_index

template<int dim>

unsigned int aspect::FEVariable< dim >::block_index

The index of the block of the linear system this variable is placed in (within the FEVariableCollection).

Definition at line 132 of file fe_variable_collection.h.

base_index

template<int dim>

unsigned int aspect::FEVariable< dim >::base_index

This index represents the how-manyth variable this is in the FEVariableCollection and consequently the FESystem, so the

Definition at line 138 of file fe_variable_collection.h.

component_mask

template<int dim>

ComponentMask aspect::FEVariable< dim >::component_mask

The component mask of this variable.

Definition at line 143 of file fe_variable_collection.h.

scalar_extractor

template<int dim>

FEValuesExtractors::Scalar aspect::FEVariable< dim >::scalar_extractor

private

Stores the object returned by extractor_scalar().

Definition at line 159 of file fe_variable_collection.h.

vector_extractor

template<int dim>

FEValuesExtractors::Vector aspect::FEVariable< dim >::vector_extractor

private

Stores the object returned by extractor_vector().

Definition at line 164 of file fe_variable_collection.h.

---

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

• /home/bob/source/include/aspect/fe_variable_collection.h