dune-pdelab  2.4-dev
Public Types | Public Member Functions | List of all members
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 >:
Inheritance graph

Public Types

typedef AnalyticGridFunctionTraits< GV, RF, dimR > Traits
 
typedef AnalyticGridFunctionBase< Traits, ConstGridFunction< GV, RF, dimR > > BaseT
 
typedef GridFunctionTag ImplementationTag
 
typedef AnalyticGridFunctionTraits< GV, RF, dimR >::GridViewType GridViewType
 Type of the GridView. More...
 

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::GridViewTypegetGridView () 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
GVThe type of the GridView
RFThe type of the range field
dimRangeThe dimension of the Range

Member Typedef Documentation

template<typename GV, typename RF, unsigned dimR = 1>
typedef AnalyticGridFunctionBase< Traits, ConstGridFunction<GV,RF, dimR> > Dune::PDELab::ConstGridFunction< GV, RF, dimR >::BaseT

Type of the GridView.

template<typename GV, typename RF, unsigned dimR = 1>
typedef AnalyticGridFunctionTraits<GV,RF,dimR> Dune::PDELab::ConstGridFunction< GV, RF, dimR >::Traits

Constructor & Destructor Documentation

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
gvThe 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

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

Return the data set type of this function.

Referenced by Dune::PDELab::GridFunctionOutputParameters::setDataSetType().

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

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
xPosition in global coordinates where to evaluate.
yThe resulting value.
const Traits::GridViewType& Dune::PDELab::AnalyticGridFunctionBase< AnalyticGridFunctionTraits< GV, RF, dimR > , ConstGridFunction< GV, RF, dimR > >::getGridView ( ) const
inlineinherited
void Dune::PDELab::GridFunctionOutputParameters::setDataSetType ( Output::DataSetType  dataSetType)
inlineinherited

Set the data set type of this function.

References Dune::PDELab::GridFunctionOutputParameters::dataSetType().

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: