Ikarus::VectorAssembler< VA, FEC, DV, VT > Class Template Reference

The VectorAssembler provides an interface for an assembler that assembles vector quantities. More...

#include <ikarus/assembler/interface.hh>

Inheritance diagram for Ikarus::VectorAssembler< VA, FEC, DV, VT >:

Public Types
using	VectorAssemblerType = VA
using	VectorType = VT
using	FEContainerRaw = std::remove_cvref_t< FEC >
	Type of the raw finite element container. More...
using	FERequirement = typename FEContainerRaw::value_type::Requirement
	Type of the finite element requirement. More...
using	GlobalIndex = typename FEContainerRaw::value_type::GlobalIndex
	Type of the global index. More...
using	DirichletValuesType = DV
using	FEContainer = FEC

Public Member Functions
const VectorType &	vector (const FERequirement &feRequirements, VectorAffordance affordance, DBCOption dbcOption=DBCOption::Full)
	Calculates the vectorial quantity requested by the feRequirements and the affordance. Depending on the requested DBCOption, the raw, reduced or full vector is returned. Raw means the degrees of freedom associated with dirichlet boundary conditions are not changed. Full means that degrees of freedom associated with dirichlet boundary conditions are set to zero in the vector. Reduced means that degrees of freedom associated with dirichlet boundary conditions are removed and the returned vector has reduced size. More...
const VectorType &	vector (DBCOption dbcOption)
	Calculates the vectorial quantity requested by the bound feRequirements and the affordance. Depending on the requested DBCOption, the raw, reduced or full vector is returned. Raw means the degrees of freedom associated with dirichlet boundary conditions are not changed. Full means that degrees of freedom associated with dirichlet boundary conditions are set to zero in the vector. Reduced means that degrees of freedom associated with dirichlet boundary conditions are removed and the returned vector has reduced size. More...
const VectorType &	vector ()
	Calculates the vectorial quantity requested by the bound feRequirements, the affordance and the dBCOption. Depending on the DBCOption, the raw, reduced or full vector is returned. Raw means the degrees of freedom associated with dirichlet boundary conditions are not changed. Full means that degrees of freedom associated with dirichlet boundary conditions are set to zero in the vector. Reduced means that degrees of freedom associated with dirichlet boundary conditions are removed and the returned vector has reduced size. More...

Detailed Description

template<typename VA, typename FEC, typename DV, typename VT>
class Ikarus::VectorAssembler< VA, FEC, DV, VT >

Template Parameters

VA	Type of the vector assembler
FEC	Type of the finite element container.
DV	Type of the Dirichlet values.
VT	Type of the vector quantity

Member Typedef Documentation

DirichletValuesType

template<typename VA , typename FEC , typename DV , typename VT >

using Ikarus::VectorAssembler< VA, FEC, DV, VT >::DirichletValuesType = DV

FEContainer

template<typename VA , typename FEC , typename DV , typename VT >

using Ikarus::VectorAssembler< VA, FEC, DV, VT >::FEContainer = FEC

FEContainerRaw

template<typename VA , typename FEC , typename DV , typename VT >

using Ikarus::VectorAssembler< VA, FEC, DV, VT >::FEContainerRaw = std::remove_cvref_t<FEC>

FERequirement

template<typename VA , typename FEC , typename DV , typename VT >

using Ikarus::VectorAssembler< VA, FEC, DV, VT >::FERequirement = typename FEContainerRaw::value_type::Requirement

GlobalIndex

template<typename VA , typename FEC , typename DV , typename VT >

using Ikarus::VectorAssembler< VA, FEC, DV, VT >::GlobalIndex = typename FEContainerRaw::value_type::GlobalIndex

VectorAssemblerType

template<typename VA , typename FEC , typename DV , typename VT >

using Ikarus::VectorAssembler< VA, FEC, DV, VT >::VectorAssemblerType = VA

VectorType

template<typename VA , typename FEC , typename DV , typename VT >

using Ikarus::VectorAssembler< VA, FEC, DV, VT >::VectorType = VT

Member Function Documentation

vector() [1/3]

template<typename VA , typename FEC , typename DV , typename VT >

const VectorType & Ikarus::VectorAssembler< VA, FEC, DV, VT >::vector ( )

inline

Returns

Const reference to the calculated vectorial quantity.

Here is the caller graph for this function:

vector() [2/3]

template<typename VA , typename FEC , typename DV , typename VT >

const VectorType & Ikarus::VectorAssembler< VA, FEC, DV, VT >::vector ( const FERequirement &  feRequirements, VectorAffordance  affordance, DBCOption  dbcOption = DBCOption::Full  )

inline

Parameters

feRequirements	Reference to the finite element requirements.
affordance	The vector affordance
dbcOption	The DBCOption

Returns

Const reference to the calculated vectorial quantity.

vector() [3/3]

template<typename VA , typename FEC , typename DV , typename VT >

const VectorType & Ikarus::VectorAssembler< VA, FEC, DV, VT >::vector ( DBCOption  dbcOption )

inline

Parameters

dbcOption

The DBCOption

Returns

Const reference to the calculated vectorial quantity.

---

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

• assembler/interface.hh