Class representing the requirements for finite element calculations. More...

#include <ikarus/finiteelements/ferequirements.hh>

Public Types
using	SolutionVectorType = SV
	Type of the solution vector. More...

using	ParameterType = PM
	Type of the parameter. More...

Public Member Functions
	FERequirements ()=default
	Default constructor. More...

template<typename SV2 = SV, typename PM2 = PM>
	FERequirements (SV2 &&solVec, PM2 &&parameter)
	Constructor initializing the solution vector and parameter. More...

template<typename PB >
	FERequirements (const Ikarus::BasisHandler< PB > &basis)
	Constructor from a basis. More...

	FERequirements (const FERequirements &other)
	Copy constructor. More...

FERequirements &	operator= (const FERequirements &other)
	Copy assignment operator. More...

FERequirements &	insertParameter (const PM &val)
	Insert a parameter into the requirements. More...

template<typename SV2 = SolutionVectorType>
FERequirements &	insertGlobalSolution (SV2 &&solVec)
	Insert a global solution vector into the requirements. More...

const SolutionVectorType &	globalSolution () const
	Get the global solution vector. More...

SV &	globalSolution ()
	Get the global solution vector. More...

std::size_t	size ()
	A helper function to get the size of the solution vector. More...

const PM &	parameter () const
	Get the parameter value. More...

PM &	parameter ()
	Get the parameter value. More...

bool	populated () const
	Tells if the class contains all needed values. More...

template<typename T >
SV &	operator+= (const T &rhs)
	Enables the usage of the class as a solution vector. More...

template<typename UF >
void	syncParameterAndGlobalSolution (UF &&updateFunction)
	This function syncs the parameter and the global solution vector. The can get out of sync, when the given update function changes the global solution vector due to a change of the parameter. This is usually the case for inhomogeneous boundary conditions. More...

Detailed Description

template<FESolutions sol, FEParameter para, typename SV = Eigen::VectorXd, typename PM = double>
class Ikarus::FERequirements< sol, para, SV, PM >

This class defines the requirements for finite element calculations, including the types of solution vectors and parameters needed.

Template Parameters

sol	The finite element solution tag.
para	The finite element parameter tag.
SV	Type of the solution vector, defaulting to Eigen::VectorXd.
PM	Type of the parameter, defaulting to double.

Member Typedef Documentation

◆ ParameterType

template<FESolutions sol, FEParameter para, typename SV = Eigen::VectorXd, typename PM = double>

using Ikarus::FERequirements< sol, para, SV, PM >::ParameterType = PM

◆ SolutionVectorType

template<FESolutions sol, FEParameter para, typename SV = Eigen::VectorXd, typename PM = double>

using Ikarus::FERequirements< sol, para, SV, PM >::SolutionVectorType = SV

Constructor & Destructor Documentation

◆ FERequirements() [1/4]

template<FESolutions sol, FEParameter para, typename SV = Eigen::VectorXd, typename PM = double>

Ikarus::FERequirements< sol, para, SV, PM >::FERequirements ( )

default

◆ FERequirements() [2/4]

template<FESolutions sol, FEParameter para, typename SV = Eigen::VectorXd, typename PM = double>

template<typename SV2 = SV, typename PM2 = PM>

Ikarus::FERequirements< sol, para, SV, PM >::FERequirements	(	SV2 &&	solVec,
		PM2 &&	parameter
	)

inline

Parameters

solVec	Solution vector.
parameter	Parameter value.

◆ FERequirements() [3/4]

template<FESolutions sol, FEParameter para, typename SV = Eigen::VectorXd, typename PM = double>

template<typename PB >

Ikarus::FERequirements< sol, para, SV, PM >::FERequirements ( const Ikarus::BasisHandler< PB > & basis )

inline

Template Parameters

PB	The type of the basis.

Parameters

basis the basis

◆ FERequirements() [4/4]

template<FESolutions sol, FEParameter para, typename SV = Eigen::VectorXd, typename PM = double>

Ikarus::FERequirements< sol, para, SV, PM >::FERequirements ( const FERequirements< sol, para, SV, PM > & other )

inline

Performs a deep copy of the solution vector and parameter.

Parameters

other The object to copy from.

Member Function Documentation

◆ globalSolution() [1/2]

template<FESolutions sol, FEParameter para, typename SV = Eigen::VectorXd, typename PM = double>

SV & Ikarus::FERequirements< sol, para, SV, PM >::globalSolution ( )

inline

Returns: Reference to the raw global solution vector.

◆ globalSolution() [2/2]

template<FESolutions sol, FEParameter para, typename SV = Eigen::VectorXd, typename PM = double>

const SolutionVectorType & Ikarus::FERequirements< sol, para, SV, PM >::globalSolution ( ) const

inline

Returns: Reference to the raw global solution vector.

Here is the caller graph for this function:

◆ insertGlobalSolution()

template<FESolutions sol, FEParameter para, typename SV = Eigen::VectorXd, typename PM = double>

template<typename SV2 = SolutionVectorType>

FERequirements & Ikarus::FERequirements< sol, para, SV, PM >::insertGlobalSolution ( SV2 && solVec )

inline

This function inserts the specified global solution vector into the requirements and deletes the old one.

Parameters

solVec Reference to the raw global solution vector.

Returns: Reference to the updated FERequirements instance.

Here is the caller graph for this function:

◆ insertParameter()

template<FESolutions sol, FEParameter para, typename SV = Eigen::VectorXd, typename PM = double>

FERequirements & Ikarus::FERequirements< sol, para, SV, PM >::insertParameter ( const PM & val )

inline

This function inserts the specified parameter into the requirements.

Parameters

val	Reference to the raw parameter value.

Returns: Reference to the updated FERequirements instance.

Here is the caller graph for this function:

◆ operator+=()

template<FESolutions sol, FEParameter para, typename SV = Eigen::VectorXd, typename PM = double>

template<typename T >

SV & Ikarus::FERequirements< sol, para, SV, PM >::operator+= ( const T & rhs )

inline

Template Parameters

T	The type of the value to add to the solution vector.

Parameters

rhs	The value to add to the solution vector.

Returns: Reference to the updated solution vector.

◆ operator=()

template<FESolutions sol, FEParameter para, typename SV = Eigen::VectorXd, typename PM = double>

FERequirements & Ikarus::FERequirements< sol, para, SV, PM >::operator= ( const FERequirements< sol, para, SV, PM > & other )

inline

Performs a deep copy of the solution vector and parameter.

Parameters

other The object to assign from.

Returns: Reference to the updated FERequirements instance.

◆ parameter() [1/2]

template<FESolutions sol, FEParameter para, typename SV = Eigen::VectorXd, typename PM = double>

PM & Ikarus::FERequirements< sol, para, SV, PM >::parameter ( )

inline

Returns: Reference to the parameter value.

◆ parameter() [2/2]

template<FESolutions sol, FEParameter para, typename SV = Eigen::VectorXd, typename PM = double>

const PM & Ikarus::FERequirements< sol, para, SV, PM >::parameter ( ) const

inline

Returns: Reference to the parameter value.

Here is the caller graph for this function:

◆ populated()

template<FESolutions sol, FEParameter para, typename SV = Eigen::VectorXd, typename PM = double>

bool Ikarus::FERequirements< sol, para, SV, PM >::populated ( ) const

inline

Returns: Bool indicating if all values are assigned.

◆ size()

template<FESolutions sol, FEParameter para, typename SV = Eigen::VectorXd, typename PM = double>

std::size_t Ikarus::FERequirements< sol, para, SV, PM >::size ( )

inline

Returns: Size of the solution vector.

◆ syncParameterAndGlobalSolution()

template<FESolutions sol, FEParameter para, typename SV = Eigen::VectorXd, typename PM = double>

template<typename UF >

void Ikarus::FERequirements< sol, para, SV, PM >::syncParameterAndGlobalSolution ( UF && updateFunction )

inline

Template Parameters

UF	The type of the update function.

Parameters

updateFunction The update function.

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

ferequirements.hh

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ ParameterType

◆ SolutionVectorType

Constructor & Destructor Documentation

◆ FERequirements() [1/4]

◆ FERequirements() [2/4]

◆ FERequirements() [3/4]

◆ FERequirements() [4/4]

Member Function Documentation

◆ globalSolution() [1/2]

◆ globalSolution() [2/2]

◆ insertGlobalSolution()

◆ insertParameter()

◆ operator+=()

◆ operator=()

◆ parameter() [1/2]

◆ parameter() [2/2]

◆ populated()

◆ size()

◆ syncParameterAndGlobalSolution()