Ikarus::ResultFunction< AS, RT, UserFunction > Class Template Reference

Wrapper to evaluate results for a vtkwriter. Works both out-of-the-box with Dune::VTK and Dune::Vtk. More...

#include <ikarus/io/resultfunction.hh>

Inheritance diagram for Ikarus::ResultFunction< AS, RT, UserFunction >:

Public Types
using	Assembler = AS
using	GridView = typename Assembler::GridView
using	FERequirementType = typename Assembler::FERequirement
using	FEContainer = typename Assembler::FEContainer
using	FiniteElement = typename std::remove_cvref_t< FEContainer >::value_type
using	ctype = typename GridView::ctype
using	Entity = typename GridView::template Codim< 0 >::Entity

Public Member Functions
double	evaluate (int comp, const Entity &e, const Dune::FieldVector< ctype, griddim > &local) const override
	Evaluate the component at a given entity and local coordinates. More...
int	ncomps () const override
	Get the number of components. More...
constexpr std::string	name () const override
	Get the name of the result type. More...
Dune::VTK::Precision	precision () const override
	Get the precision used for this result. More...
template<typename UF = UserFunction>
	ResultFunction (std::shared_ptr< Assembler > assembler, Dune::VTK::Precision prec=Dune::VTK::Precision::float64, UF &&userFunction={})
	Construct a new Result Function object. More...

Static Public Attributes
static constexpr int	griddim = GridView::dimension

Detailed Description

template<typename AS, template< typename, int, int > class RT, typename UserFunction = Impl::DefaultUserFunction>
requires (Concepts::FlatAssembler<AS> and Concepts::ResultType<RT>)
class Ikarus::ResultFunction< AS, RT, UserFunction >

Usage:

auto resultFunction = Ikarus::makeResultFunction<resType>(assembler);
vtkWriter.addVertexData(resultFunction);

Template Parameters

AS	underlying assembler (provides the finite elements and the requested results)
RT	requested result type
UserFunction	Type of the user-defined function for custom result evaluation (default is DefaultUserFunction)

Member Typedef Documentation

Assembler

template<typename AS , template< typename, int, int > class RT, typename UserFunction = Impl::DefaultUserFunction>

using Ikarus::ResultFunction< AS, RT, UserFunction >::Assembler = AS

ctype

template<typename AS , template< typename, int, int > class RT, typename UserFunction = Impl::DefaultUserFunction>

using Ikarus::ResultFunction< AS, RT, UserFunction >::ctype = typename GridView::ctype

Entity

template<typename AS , template< typename, int, int > class RT, typename UserFunction = Impl::DefaultUserFunction>

using Ikarus::ResultFunction< AS, RT, UserFunction >::Entity = typename GridView::template Codim<0>::Entity

FEContainer

template<typename AS , template< typename, int, int > class RT, typename UserFunction = Impl::DefaultUserFunction>

using Ikarus::ResultFunction< AS, RT, UserFunction >::FEContainer = typename Assembler::FEContainer

FERequirementType

template<typename AS , template< typename, int, int > class RT, typename UserFunction = Impl::DefaultUserFunction>

using Ikarus::ResultFunction< AS, RT, UserFunction >::FERequirementType = typename Assembler::FERequirement

FiniteElement

template<typename AS , template< typename, int, int > class RT, typename UserFunction = Impl::DefaultUserFunction>

using Ikarus::ResultFunction< AS, RT, UserFunction >::FiniteElement = typename std::remove_cvref_t<FEContainer>::value_type

GridView

template<typename AS , template< typename, int, int > class RT, typename UserFunction = Impl::DefaultUserFunction>

using Ikarus::ResultFunction< AS, RT, UserFunction >::GridView = typename Assembler::GridView

Constructor & Destructor Documentation

ResultFunction()

template<typename AS , template< typename, int, int > class RT, typename UserFunction = Impl::DefaultUserFunction>

template<typename UF = UserFunction>

Ikarus::ResultFunction< AS, RT, UserFunction >::ResultFunction ( std::shared_ptr< Assembler >  assembler, Dune::VTK::Precision  prec = Dune::VTK::Precision::float64, UF &&  userFunction = {}  )

inline

Template Parameters

UF	Type of the user function

Parameters

assembler	shared pointer to the underlying assembler (provides the finite elements and the requested results)
prec	(optional) specify the used precision (only has an effect when using resultfunciton with Dune::VTK::VTKWriter)
userFunction	the user function (default is DefaultUserFunction)

Member Function Documentation

evaluate()

template<typename AS , template< typename, int, int > class RT, typename UserFunction = Impl::DefaultUserFunction>

double Ikarus::ResultFunction< AS, RT, UserFunction >::evaluate ( int  comp, const Entity &  e, const Dune::FieldVector< ctype, griddim > &  local  ) const

inlineoverride

This function is required by the Dune::VTKFunction interface.

Parameters

comp	Stress component index
e	Entity on which to evaluate the stress
local	Local coordinates within the entity

Returns

Stress component value

name()

template<typename AS , template< typename, int, int > class RT, typename UserFunction = Impl::DefaultUserFunction>

constexpr std::string Ikarus::ResultFunction< AS, RT, UserFunction >::name ( ) const

inlineconstexproverride

This function is required by the Dune::VTKFunction interface.

Returns

String representing the name of the result type

ncomps()

template<typename AS , template< typename, int, int > class RT, typename UserFunction = Impl::DefaultUserFunction>

int Ikarus::ResultFunction< AS, RT, UserFunction >::ncomps ( ) const

inlineoverride

This function is required by the Dune::VTKFunction interface.

Returns

Number of stress components

precision()

template<typename AS , template< typename, int, int > class RT, typename UserFunction = Impl::DefaultUserFunction>

Dune::VTK::Precision Ikarus::ResultFunction< AS, RT, UserFunction >::precision ( ) const

inlineoverride

This function is part of the Dune::VTKFunction interface. This has no affect when the ResultFunction is used with the dune-vtk module

Returns

Precision (i.e. float64 or float32)

Member Data Documentation

griddim

template<typename AS , template< typename, int, int > class RT, typename UserFunction = Impl::DefaultUserFunction>

constexpr int Ikarus::ResultFunction< AS, RT, UserFunction >::griddim = GridView::dimension

staticconstexpr

---

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

• resultfunction.hh