Function is the interface for evaluatable functions \( f:\Omega\to\mathbb{R}^m \). More...

#include <concepts.hh>

Detailed Description

Function is the interface for evaluatable functions \( f:\Omega\to\mathbb{R}^m \).

Functions allow the evaluation of possibly vector valued functions defined on a spatial domain given by a grid and provide some metadata.

Prominent models of the Function concept are FunctionSpaceElement s.

Definition at line 323 of file concepts.hh.

Public Types
typedef unspecified	Scalar

typedef Dune::FieldVector< Scalar, components >	ValueType

Public Member Functions
template<class Cell >
int	order (Cell const &cell) const

template<class Cell >
ValueType	value (Cell const &cell, Dune::FieldVector< typename Cell::Geometry::ctype, Cell::dimension > const &localCoordinate) const

Static Public Attributes
static int const	components = unspecified

Member Typedef Documentation

◆ Scalar

typedef unspecified Function::Scalar

A scalar floating point type, which is the field over which the return values are defined.

Definition at line 330 of file concepts.hh.

◆ ValueType

typedef Dune::FieldVector<Scalar,components> Function::ValueType

The type of the function values.

Definition at line 340 of file concepts.hh.

Member Function Documentation

◆ order()

template<class Cell >

int Function::order ( Cell const & cell ) const

Returns the polynomial order of the function on the specified cell (grid entity of codim 0). If the function is locally not polynomial, std::numeric_limits<int>::max() is returned.

Referenced by Kaskade::forEachQuadPoint(), Kaskade::ScalarProductView< Function >::order(), Kaskade::FunctionViews::AbsSquare< Function >::order(), Kaskade::FunctionViews::Gradient< Function, asVector >::order(), and Kaskade::FunctionViews::GradientAbsSquare< Function >::order().

◆ value()

template<class Cell >

ValueType Function::value	(	Cell const &	cell,
		Dune::FieldVector< typename Cell::Geometry::ctype, Cell::dimension > const &	localCoordinate
	)		const

Returns the value of the function at the specified local coordinate of the given cell.

Referenced by Kaskade::forEachQuadPoint(), Kaskade::interpolateGlobally(), Kaskade::ScalarProductView< Function >::value(), Kaskade::AdvectedFunctionView< Function, Velocity >::value(), and Kaskade::FunctionViews::AbsSquare< Function >::value().

Member Data Documentation

◆ components

int const Function::components = unspecified

static

The number of vectorial components of the result value.

Definition at line 335 of file concepts.hh.

Referenced by Kaskade::UniformSampler< Function >::writeVTK().

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

concepts.hh