Class for handling Dirichlet boundary conditions in Ikarus. More...

#include <ikarus/utils/dirichletvalues.hh>

Public Types
using	Basis = std::remove_cvref_t< B >

using	FlagsType = FC

using	BackendType = decltype(Dune::Functions::istlVectorBackend(std::declval< FlagsType & >()))

using	SizeType = typename DeriveSizeType< FlagsType >::SizeType

Public Member Functions
	DirichletValues (const B &basis)

template<typename F , typename TreePath = Dune::TypeTree::HybridTreePath<>>
void	fixBoundaryDOFs (F &&f, TreePath &&treePath={})
	Function to fix (set boolean values to true or false) degrees of freedom on the boundary. More...

template<typename F >
void	fixDOFs (F &&f)
	Function to fix (set boolean values to true or false) degrees of freedom. More...

template<typename MultiIndex > requires (not std::integral<MultiIndex>)
void	setSingleDOF (const MultiIndex i, bool flag)
	Fixes and unfixes (set boolean value to true or false) a specific degree of freedom. More...

void	setSingleDOF (std::size_t i, bool flag)
	Fixes or unfixes (set boolean value to true or false) a specific degree of freedom. More...

void	reset ()
	Resets all degrees of freedom. More...

const auto &	basis () const

template<typename MultiIndex > requires (not std::integral<MultiIndex>)
bool	isConstrained (const MultiIndex &multiIndex) const

bool	isConstrained (std::size_t i) const

auto	fixedDOFsize () const

auto	size () const

auto &	container () const

template<typename F >
void	storeInhomogeneousBoundaryCondition (F &&f)
	Function to insert a function for inhomogeneous Dirichlet boundary conditions. More...

void	evaluateInhomogeneousBoundaryCondition (Eigen::VectorXd &xIh, const double &lambda)
	Function to evaluate all stored inhomogeneous Dirichlet boundary functions. More...

void	evaluateInhomogeneousBoundaryConditionDerivative (Eigen::VectorXd &xIh, const double &lambda)
	Function to evaluate all stored inhomogeneous Dirichlet boundary derivative functions. More...

Static Public Attributes
static constexpr int	worldDimension = Basis::GridView::dimensionworld

Detailed Description

template<typename B, typename FC = std::vector<bool>>
class Ikarus::DirichletValues< B, FC >

The DirichletValues class provides functionalities for fixing degrees of freedom and storing inhomogeneous Dirichlet boundary conditions. It supports fixing degrees of freedom using various callback functions and stores functions for inhomogeneous Dirichlet boundary conditions.

Template Parameters

B	Type of the finite element basis
FC	Type for storing Dirichlet flags (default is std::vector<bool>)

Member Typedef Documentation

◆ BackendType

template<typename B , typename FC = std::vector<bool>>

using Ikarus::DirichletValues< B, FC >::BackendType = decltype(Dune::Functions::istlVectorBackend(std::declval<FlagsType&>()))

◆ Basis

template<typename B , typename FC = std::vector<bool>>

using Ikarus::DirichletValues< B, FC >::Basis = std::remove_cvref_t<B>

◆ FlagsType

template<typename B , typename FC = std::vector<bool>>

using Ikarus::DirichletValues< B, FC >::FlagsType = FC

◆ SizeType

template<typename B , typename FC = std::vector<bool>>

using Ikarus::DirichletValues< B, FC >::SizeType = typename DeriveSizeType<FlagsType>::SizeType

Constructor & Destructor Documentation

◆ DirichletValues()

template<typename B , typename FC = std::vector<bool>>

Ikarus::DirichletValues< B, FC >::DirichletValues ( const B & basis )

inlineexplicit

Member Function Documentation

◆ basis()

template<typename B , typename FC = std::vector<bool>>

const auto & Ikarus::DirichletValues< B, FC >::basis ( ) const

inline

◆ container()

template<typename B , typename FC = std::vector<bool>>

auto & Ikarus::DirichletValues< B, FC >::container ( ) const

inline

Here is the caller graph for this function:

◆ evaluateInhomogeneousBoundaryCondition()

template<typename B , typename FC = std::vector<bool>>

void Ikarus::DirichletValues< B, FC >::evaluateInhomogeneousBoundaryCondition	(	Eigen::VectorXd &	xIh,
		const double &	lambda
	)

inline

This function evaluates all stored inhomogeneous Dirichlet boundary functions at all positions where the corresponding degrees of freedom are true.

Parameters

xIh	The vector where the interpolated result should be stored
lambda	The load factor

◆ evaluateInhomogeneousBoundaryConditionDerivative()

template<typename B , typename FC = std::vector<bool>>

void Ikarus::DirichletValues< B, FC >::evaluateInhomogeneousBoundaryConditionDerivative	(	Eigen::VectorXd &	xIh,
		const double &	lambda
	)

inline

This function evaluates all stored inhomogeneous Dirichlet boundary derivative functions at all positions where the corresponding degrees of freedom are true.

Parameters

xIh	The vector where the interpolated result should be stored
lambda	The load factor

◆ fixBoundaryDOFs()

template<typename B , typename FC = std::vector<bool>>

template<typename F , typename TreePath = Dune::TypeTree::HybridTreePath<>>

void Ikarus::DirichletValues< B, FC >::fixBoundaryDOFs	(	F &&	f,
		TreePath &&	treePath = `{}`
	)

inline

This function takes a callback function, which will be called with the boolean vector of fixed boundary degrees of freedom and the usual arguments of Dune::Functions::forEachBoundaryDOF.

Parameters

f	A callback function
treePath	An optional argument specifying a tree path to a subspacebasis, e.g. Dune::Indices::_0

◆ fixDOFs()

template<typename B , typename FC = std::vector<bool>>

template<typename F >

void Ikarus::DirichletValues< B, FC >::fixDOFs ( F && f )

inline

This function takes a callback function, which will be called with the stored function space basis and the boolean vector of fixed boundary degrees of freedom.

Parameters

f	A callback function

Here is the caller graph for this function:

◆ fixedDOFsize()

template<typename B , typename FC = std::vector<bool>>

auto Ikarus::DirichletValues< B, FC >::fixedDOFsize ( ) const

inline

Here is the caller graph for this function:

◆ isConstrained() [1/2]

template<typename B , typename FC = std::vector<bool>>

template<typename MultiIndex >
requires (not std::integral<MultiIndex>)

bool Ikarus::DirichletValues< B, FC >::isConstrained ( const MultiIndex & multiIndex ) const

inline

Here is the caller graph for this function:

◆ isConstrained() [2/2]

template<typename B , typename FC = std::vector<bool>>

bool Ikarus::DirichletValues< B, FC >::isConstrained ( std::size_t i ) const

inline

◆ reset()

template<typename B , typename FC = std::vector<bool>>

void Ikarus::DirichletValues< B, FC >::reset ( )

inline

Here is the caller graph for this function:

◆ setSingleDOF() [1/2]

template<typename B , typename FC = std::vector<bool>>

template<typename MultiIndex >
requires (not std::integral<MultiIndex>)

void Ikarus::DirichletValues< B, FC >::setSingleDOF	(	const MultiIndex	i,
		bool	flag
	)

inline

Parameters

i	An index indicating the DOF number to be fixed
flag	Boolean indicating whether the DOF should fixed or not

Here is the caller graph for this function:

◆ setSingleDOF() [2/2]

template<typename B , typename FC = std::vector<bool>>

void Ikarus::DirichletValues< B, FC >::setSingleDOF	(	std::size_t	i,
		bool	flag
	)

inline

Parameters

i	An index indicating the DOF number to be fixed
flag	Boolean indicating whether the DOF should fixed or not

◆ size()

template<typename B , typename FC = std::vector<bool>>

auto Ikarus::DirichletValues< B, FC >::size ( ) const

inline

Here is the caller graph for this function:

◆ storeInhomogeneousBoundaryCondition()

template<typename B , typename FC = std::vector<bool>>

template<typename F >

void Ikarus::DirichletValues< B, FC >::storeInhomogeneousBoundaryCondition ( F && f )

inline

This function takes a callback function, which will be called with the current coordinate vector and the scalar load factor. It creates internally the first derivative of the passed function and stores them simultaneously.

Parameters

f	A callback function

Member Data Documentation

◆ worldDimension

template<typename B , typename FC = std::vector<bool>>

constexpr int Ikarus::DirichletValues< B, FC >::worldDimension = Basis::GridView::dimensionworld

staticconstexpr

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

utils/dirichletvalues.hh

Public Types

Public Member Functions

Static Public Attributes

Detailed Description

Member Typedef Documentation

◆ BackendType

◆ Basis

◆ FlagsType

◆ SizeType

Constructor & Destructor Documentation

◆ DirichletValues()

Member Function Documentation

◆ basis()

◆ container()

◆ evaluateInhomogeneousBoundaryCondition()

◆ evaluateInhomogeneousBoundaryConditionDerivative()

◆ fixBoundaryDOFs()

◆ fixDOFs()

◆ fixedDOFsize()

◆ isConstrained() [1/2]

◆ isConstrained() [2/2]

◆ reset()

◆ setSingleDOF() [1/2]

◆ setSingleDOF() [2/2]

◆ size()

◆ storeInhomogeneousBoundaryCondition()

Member Data Documentation

◆ worldDimension