dune-pdelab  2.5-dev
Public Types | Public Member Functions | List of all members
Dune::PDELab::AnalyticGridFunctionBase< T, Imp > Class Template Reference

an analytic grid function More...

#include <dune/pdelab/common/function.hh>

Inheritance diagram for Dune::PDELab::AnalyticGridFunctionBase< T, Imp >:
Inheritance graph

Public Types

typedef T Traits
 
typedef GridFunctionTag ImplementationTag
 
typedef T::GridViewType GridViewType
 Type of the GridView. More...
 
using Output = typename Base::Output
 

Public Member Functions

 AnalyticGridFunctionBase (const typename Traits::GridViewType &g_)
 Construct an Analytic GridFunctionBase given a GridView g_. More...
 
void evaluate (const typename Traits::ElementType &e, const typename Traits::DomainType &x, typename Traits::RangeType &y) const
 Evaluate the GridFunction at given position. More...
 
const Traits::GridViewType & getGridView () const
 
Output::DataSetType dataSetType () const
 Return the data set type of this function. More...
 
void setDataSetType (Output::DataSetType dataSetType)
 Set the data set type of this function. More...
 

Detailed Description

template<typename T, typename Imp>
class Dune::PDELab::AnalyticGridFunctionBase< T, Imp >

an analytic grid function

This is a convenience class which eases the creation of analytic GridFunctions. Classes derived from it need only implement a method evaluateGlobal(const Dune::FieldVector<typename Traits::DomainFieldType,GV::dimensionworld> &x_global, RangeType &y) to have a full-fledged GridFunction.

Template Parameters
TThe Traits class
ImpClass implementing the function. Imp must be derived from AnalyticGridFunctionBase in some way (Barton-Nackman-Trick).

Member Typedef Documentation

◆ GridViewType

typedef T::GridViewType Dune::PDELab::GridFunctionBase< T, AnalyticGridFunctionBase< T, Imp > >::GridViewType
inherited

Type of the GridView.

◆ ImplementationTag

◆ Output

using Dune::PDELab::GridFunctionBase< T, AnalyticGridFunctionBase< T, Imp > >::Output = typename Base::Output
inherited

◆ Traits

template<typename T, typename Imp>
typedef T Dune::PDELab::AnalyticGridFunctionBase< T, Imp >::Traits

Constructor & Destructor Documentation

◆ AnalyticGridFunctionBase()

template<typename T, typename Imp>
Dune::PDELab::AnalyticGridFunctionBase< T, Imp >::AnalyticGridFunctionBase ( const typename Traits::GridViewType &  g_)
inline

Construct an Analytic GridFunctionBase given a GridView g_.

Member Function Documentation

◆ dataSetType()

Output::DataSetType Dune::PDELab::GridFunctionOutputParameters::dataSetType ( ) const
inlineinherited

Return the data set type of this function.

◆ evaluate()

template<typename T, typename Imp>
void Dune::PDELab::AnalyticGridFunctionBase< T, Imp >::evaluate ( const typename Traits::ElementType &  e,
const typename Traits::DomainType &  x,
typename Traits::RangeType &  y 
) const
inline

Evaluate the GridFunction at given position.

Evaluates components of the grid function at the given position and returns these values in a vector.

Parameters
[in]eThe entity to evaluate on
[in]xThe position in entity-local coordinates
[out]yThe result of the evaluation

◆ getGridView()

template<typename T, typename Imp>
const Traits::GridViewType& Dune::PDELab::AnalyticGridFunctionBase< T, Imp >::getGridView ( ) const
inline

◆ setDataSetType()

void Dune::PDELab::GridFunctionOutputParameters::setDataSetType ( Output::DataSetType  dataSetType)
inlineinherited

Set the data set type of this function.


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