Dune::PDELab::ConstGridFunction< GV, RF, dimR > Class Template Reference

GridFunction returning a constant value everywhere. More...

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

Inheritance diagram for Dune::PDELab::ConstGridFunction< GV, RF, dimR >:

Public Types
typedef AnalyticGridFunctionTraits< GV, RF, dimR >	Traits
typedef AnalyticGridFunctionBase< Traits, ConstGridFunction< GV, RF, dimR > >	BaseT
typedef GridFunctionTag	ImplementationTag
typedef AnalyticGridFunctionTraits< GV, RF, 1 > ::GridViewType	GridViewType
	Type of the GridView. More...
using	Output = typename Base::Output

Public Member Functions
	ConstGridFunction (const GV &gv, const typename Traits::RangeType &val_=1)
	Contruct a Const GridFunction. More...
void	evaluateGlobal (const typename Traits::DomainType &x, typename Traits::RangeType &y) const
	evaluate the function globally More...
void	evaluate (const typename Traits::ElementType &e, const typename Traits::DomainType &x, typename Traits::RangeType &y) const
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...
template<typename Time >
void	setTime (Time t)
	set time for subsequent evaluation More...

Detailed Description

template<typename GV, typename RF, unsigned dimR = 1>
class Dune::PDELab::ConstGridFunction< GV, RF, dimR >

GridFunction returning a constant value everywhere.

Template Parameters

GV	The type of the GridView
RF	The type of the range field
dimRange	The dimension of the Range

Member Typedef Documentation

BaseT

template<typename GV , typename RF , unsigned dimR = 1>

typedef AnalyticGridFunctionBase< Traits, ConstGridFunction<GV,RF, dimR> > Dune::PDELab::ConstGridFunction< GV, RF, dimR >::BaseT

GridViewType

typedef AnalyticGridFunctionTraits< GV, RF, 1 > ::GridViewType Dune::PDELab::GridFunctionBase< AnalyticGridFunctionTraits< GV, RF, 1 > , AnalyticGridFunctionBase< AnalyticGridFunctionTraits< GV, RF, 1 >, ConstGridFunction< GV, RF, 1 > > >::GridViewType

inherited

Type of the GridView.

ImplementationTag

typedef GridFunctionTag Dune::PDELab::GridFunctionBase< AnalyticGridFunctionTraits< GV, RF, 1 > , AnalyticGridFunctionBase< AnalyticGridFunctionTraits< GV, RF, 1 >, ConstGridFunction< GV, RF, 1 > > >::ImplementationTag

inherited

Output

using Dune::PDELab::GridFunctionBase< AnalyticGridFunctionTraits< GV, RF, 1 > , AnalyticGridFunctionBase< AnalyticGridFunctionTraits< GV, RF, 1 >, ConstGridFunction< GV, RF, 1 > > >::Output = typename Base::Output

inherited

Traits

template<typename GV , typename RF , unsigned dimR = 1>

typedef AnalyticGridFunctionTraits<GV,RF,dimR> Dune::PDELab::ConstGridFunction< GV, RF, dimR >::Traits

Constructor & Destructor Documentation

ConstGridFunction()

template<typename GV , typename RF , unsigned dimR = 1>

Dune::PDELab::ConstGridFunction< GV, RF, dimR >::ConstGridFunction ( const GV &  gv, const typename Traits::RangeType &  val_ = 1  )

inline

Contruct a Const GridFunction.

Parameters

gv	The GridView to use. It is passed as a reference to AnalyticGridFunctionBase (look there for the requirements of this argument).
val_	The value tu return on evaluation. This class stores a copy of that value.

Member Function Documentation

dataSetType()

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

inlineinherited

Return the data set type of this function.

evaluate()

void Dune::PDELab::AnalyticGridFunctionBase< AnalyticGridFunctionTraits< GV, RF, 1 > , ConstGridFunction< GV, RF, 1 > >::evaluate ( const typename Traits::ElementType &  e, const typename Traits::DomainType &  x, typename Traits::RangeType &  y  ) const

inlineinherited

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]	e	The entity to evaluate on
[in]	x	The position in entity-local coordinates
[out]	y	The result of the evaluation

evaluateGlobal()

template<typename GV , typename RF , unsigned dimR = 1>

void Dune::PDELab::ConstGridFunction< GV, RF, dimR >::evaluateGlobal ( const typename Traits::DomainType &  x, typename Traits::RangeType &  y  ) const

inline

evaluate the function globally

Parameters

x	Position in global coordinates where to evaluate.
y	The resulting value.

getGridView()

const Traits::GridViewType& Dune::PDELab::AnalyticGridFunctionBase< AnalyticGridFunctionTraits< GV, RF, 1 > , ConstGridFunction< GV, RF, 1 > >::getGridView

inlineinherited

setDataSetType()

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

inlineinherited

Set the data set type of this function.

setTime()

template<typename Time >

void Dune::PDELab::InstationaryFunctionDefaults::setTime ( Time  t )

inlineinherited

set time for subsequent evaluation

This method sets the time for subsequent calls to any of the evaluation methods.

Note

This default method does nothing, it just ensures setTime() can be called without ill effects.

Function implementation are free to restrict the types of acceptable parameters. This should be noted in the function classes documentation.

---

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

• const.hh