Classes
struct	CheckFlags
	Struct to hold flags for function checks. More...

struct	IDBCForceDefault
	Default struct used to represent that no inhomogeneous Dirichlet BCs are present. More...

struct	SolverDefault
	Default functor for solving operations. More...

struct	SyncFERequirements
	A helper struct that tells the update function of the nonlinear solver to sync the global solution based on the parameter, i.e., to sync the FERequirements. More...

struct	UpdateDefault
	Default functor for updating operations. More...

Functions
void	makeUniqueAndSort (std::ranges::random_access_range auto &r)
	Sorts and removes duplicate elements from a random access range.*. More...

template<typename T >
auto	appendUnique (std::ranges::random_access_range auto &r, T &&v)
	Appends a value to the range if it is not already present. More...

template<class C >
void	printContent (C &&c, std::ostream &os=std::cout)
	Prints the contents of a container to the specified output stream. More...

template<class C >
auto	transformValueRangeToPointerRange (C &cont)
	Transforms a value range to a pointer range. More...

template<class C >
auto	transformPointerRangeToReferenceRange (C &cont)
	Transforms a pointer range to a reference range. More...

template<typename Tuple , typename Predicate >
constexpr size_t	find_if (Tuple &&tuple, Predicate pred)
	Finds the index of the first element in the tuple satisfying a predicate. More...

template<typename Tuple , typename Predicate >
bool	none_of (Tuple &&tuple, Predicate pred)
	Checks if none of the elements in the tuple satisfy a given predicate. More...

template<typename Tuple , typename Predicate >
bool	any_of (Tuple &&tuple, Predicate pred)
	Checks if any of the elements in the tuple satisfy a given predicate. More...

template<typename Tuple , typename Predicate >
auto	filter (Tuple &&tuple, Predicate pred)
	Filters the elements of a tuple based on a given predicate. More...

template<typename... Types>
constexpr auto	unique (std::tuple< Types... > &&tuple)
	Creates a tuple with unique types from the given tuple. More...

template<typename Tuple , typename Predicate >
constexpr size_t	count_if (Tuple &&tuple, Predicate pred)
	Counts the number of elements in the tuple satisfying the given predicate. More...

template<template< auto... > class Type, typename Tuple >
constexpr int	findTypeSpecialization ()
	Finds the index of the first element in the tuple that is a specialization of the given template type. More...

template<template< auto... > class Type, typename Tuple >
auto	getSpecialization (Tuple &&tuple)
	Gets the specialization of the given template type from the tuple. More...

template<template< auto... > class Type, typename Tuple >
constexpr bool	hasTypeSpecialization ()
	Checks if a tuple has a specialization of a template type. More...

template<template< auto... > class Type, typename Tuple >
constexpr bool	countTypeSpecialization ()
	Counts the occurrences of a specialization of a template type in a tuple. More...

template<int N, class Tuple >
constexpr auto	makeTupleSubset (Tuple &&t)
	Creates a subset tuple with the first N elements from the given tuple. More...

template<class Tuple , std::size_t... I>
constexpr auto	makeTupleFromTupleIndices (Tuple &&t)
	Creates a new tuple using indices from the original tuple. More...

template<typename... Types>
auto	makeNestedTupleFlat (std::tuple< Types... >)
	Creates a flattened nested tuple. More...

template<typename Tuple >
auto	makeNestedTupleFlatAndStoreReferences (Tuple &&tup)
	Creates a flattened nested tuple and stores references. More...

template<typename T > requires traits::Pointer<T>
auto &	returnReferenceOrNulloptIfObjectIsNullPtr (T v)
	Returns a reference or std::nullopt if the object is a nullptr. More...

template<typename Fun , typename... Vars, typename... Args, typename U , typename G , typename H >
void	hessianN (const Fun &f, const autodiff::Wrt< Vars... > &wrt, const autodiff::At< Args... > &at, U &u, std::array< G, U::RowsAtCompileTime > &g, std::array< H, U::RowsAtCompileTime > &h)
	Computes the Hessian matrix for each parameter of a given function.The Hessian matrix represents the second-order partial derivatives of the function with respect to the specified variables. More...

std::tuple< Dune::Functions::Polynomial< double >, decltype(Eigen::seq(0, 0))>	findLineSegment (const Eigen::VectorXd &x, const Eigen::VectorXd &y, int segmentSize)
	Find a linear segment in a set of data points. More...

template<int size, typename LV >
void	obtainLagrangeGlobalNodePositions (const LV &localView, std::vector< Dune::FieldVector< double, size > > &lagrangeNodeGlobalCoords)
	A function to obtain the global positions of the nodes of an element with Lagrangian basis. More...

template<int worldDim, typename Basis >
auto	globalIndexFromGlobalPosition (const Basis &basis, const Dune::FieldVector< double, worldDim > &pos)
	A helper function to obtain the global index from the global positions for a Lagrange node. More...

template<typename FE >
auto	referenceElementSubEntityPositions (FE &fe, int codim)
	A function to obtain the local coordinates of subentities of an FiniteElement. More...

template<typename FE >
auto	referenceElementVertexPositions (FE &fe)
	A function to obtain the local coordinates the vertices of an FiniteElement. More...

template<typename T >
decltype(auto)	maybeDeref (T &t)
	if T is a pointer type, return the dereferenced value, otherwise return the value itself. More...

template<typename A > requires (std::is_pointer_v<std::remove_cvref_t<A>> \|\| traits::isSharedPtr<std::remove_cvref_t<A>>::value)
auto	obtainForcesDueToIDBC (const A &assembler)
	A helper function to compute the forces due to inhomogeneous Dirichlet BCs. More...

template<typename F , typename UF = UpdateDefault>
bool	checkGradient (F &f, const typename F::Domain &p, CheckFlags checkFlags=CheckFlags(), UF &&p_updateFunction={})
	Checks the gradient of a differentiable Functions. More...

template<typename F , typename UF = UpdateDefault>
bool	checkJacobian (F &f, const typename F::Domain &p, CheckFlags checkFlags=CheckFlags(), UF &&p_updateFunction={})
	Checks the Jacobian of a differentiable Functions. More...

template<typename F , typename UF = UpdateDefault>
bool	checkHessian (F &f, const typename F::Domain &p, CheckFlags checkFlags=CheckFlags(), UF &&p_updateFunction={})
	Checks the Hessian of a differentiable Functions. More...

std::tuple< Dune::Functions::Polynomial< double >, double >	polyfit (const Eigen::Ref< const Eigen::VectorXd > &x, const Eigen::Ref< const Eigen::VectorXd > &y, int deg)
	Fits a polynomial of a given degree to the given data points. More...

template<class T , class TreePath , class PowerFunc , class LeafFunc >
void	forEachLeafOrPowerLeafNode (T &&tree, TreePath &&treePath, PowerFunc &&powerFunc, LeafFunc &&leafFunc)
	A function which loops over all the nodes of a tree and performs different actions for a power node (with leaf node as child) and a leaf node depending on the corresponding functor passed. More...

template<typename LV , typename F , int myDim = LV::Element::mydimension> requires (std::convertible_to<F, std::function<bool(int, Dune::FieldVector<double, myDim> &&)>>)
void	forEachLagrangeNodePosition (const LV &localView, F &&f)
	A helper function that helps in traversing over the local coordinates of an element and call a user-desired function. More...

Variables
template<template< auto... > class Type, typename Tuple >
static constexpr bool	countTypeSpecialization_v = countTypeSpecialization<Type, Tuple>()
	Variable template for counting the occurrences of a specialization of a template type in a tuple. More...

struct Ikarus::utils::SyncFERequirements	syncFERequirements

Function Documentation

◆ forEachLagrangeNodePosition()

template<typename LV , typename F , int myDim = LV::Element::mydimension>
requires (std::convertible_to<F, std::function<bool(int, Dune::FieldVector<double, myDim> &&)>>)

void Ikarus::utils::forEachLagrangeNodePosition	(	const LV &	localView,
		F &&	f
	)

See also: Dune book page 314 for details

Template Parameters

myDim	Dimension of the geometry
LV	Type of the local view
F	Type of the functor that traverses over the local coordinate of an element

Parameters

localView	Local view bounded to an element
f	A function that traverses over the local coordinate of an element

Here is the caller graph for this function:

◆ forEachLeafOrPowerLeafNode()

template<class T , class TreePath , class PowerFunc , class LeafFunc >

void Ikarus::utils::forEachLeafOrPowerLeafNode	(	T &&	tree,
		TreePath &&	treePath,
		PowerFunc &&	powerFunc,
		LeafFunc &&	leafFunc
	)

This function is inspired from the function Dune::TypeTree::Detail::forEachNode available in dune/typetree/traversal.hh

Template Parameters

T	Type of tree.
TreePath	Type of the HybridTreePath.
PowerFunc	Type of the functor called for a power node.
LeafFunc	Type of the functor called for a leaf node.

Parameters

tree	Tree whose nodes are to be looped over.
treePath	The tree path which handles index values.
powerFunc	A functor to be called for a power node.
leafFunc	A functor to be called for a leaf node.

Here is the caller graph for this function:

◆ makeNestedTupleFlat()

template<typename... Types>

auto Ikarus::utils::makeNestedTupleFlat ( std::tuple< Types... > )

Template Parameters

Types Types contained in the original tuple.

Returns: A new flattened nested tuple.

◆ makeNestedTupleFlatAndStoreReferences()

template<typename Tuple >

auto Ikarus::utils::makeNestedTupleFlatAndStoreReferences ( Tuple && tup )

Template Parameters

Tuple Type of the original tuple.

Parameters

tup	The original tuple.

Returns: A new tuple with stored references.

This function creates a flattened nested tuple and stores references.

◆ maybeDeref()

template<typename T >

decltype(auto) Ikarus::utils::maybeDeref ( T & t )

Template Parameters

T

Parameters

t

Returns: decltype(auto)

Here is the caller graph for this function:

◆ obtainForcesDueToIDBC()

template<typename A >
requires (std::is_pointer_v<std::remove_cvref_t<A>> || traits::isSharedPtr<std::remove_cvref_t<A>>::value)

auto Ikarus::utils::obtainForcesDueToIDBC ( const A & assembler )

Template Parameters

A	Type of the assembler.

Parameters

assembler The assembler.

◆ returnReferenceOrNulloptIfObjectIsNullPtr()

template<typename T >
requires traits::Pointer<T>

auto & Ikarus::utils::returnReferenceOrNulloptIfObjectIsNullPtr ( T v )

Template Parameters

T	Type of the pointer.

Parameters

v	Pointer value.

Returns: Reference or std::nullopt.

Variable Documentation

◆ syncFERequirements

struct Ikarus::utils::SyncFERequirements Ikarus::utils::syncFERequirements

Classes

Functions

Variables

Function Documentation

◆ forEachLagrangeNodePosition()

◆ forEachLeafOrPowerLeafNode()

◆ makeNestedTupleFlat()

◆ makeNestedTupleFlatAndStoreReferences()

◆ maybeDeref()

◆ obtainForcesDueToIDBC()

◆ returnReferenceOrNulloptIfObjectIsNullPtr()

Variable Documentation

◆ syncFERequirements