dune-pdelab  2.7-git
Public Types | Public Member Functions | List of all members
Dune::PDELab::MemberFunctionToGridFunctionAdaptor< Member, Class, GV, RF, dimR > Class Template Reference

GridFunction implemented by a member function of some class. More...

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

Inheritance diagram for Dune::PDELab::MemberFunctionToGridFunctionAdaptor< Member, Class, GV, RF, dimR >:
Inheritance graph

Public Types

typedef GridFunctionTraits< GV, RF, dimR, FieldVector< RF, dimR > > Traits
 export traits class More...
 
typedef GridFunctionTag ImplementationTag
 
typedef T::GridViewType GridViewType
 Type of the GridView. More...
 
using Output = typename Base::Output
 

Public Member Functions

 MemberFunctionToGridFunctionAdaptor (const Class &obj_, Member member_, const GV &gv_)
 Construct an adaptor object. More...
 
void evaluate (const typename Traits::ElementType &e, const typename Traits::DomainType &x, typename Traits::RangeType &y) const
 
const GV & getGridView () const
 get reference to the internal gridview. More...
 
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<class Member, class Class, class GV, class RF, std::size_t dimR = 1>
class Dune::PDELab::MemberFunctionToGridFunctionAdaptor< Member, Class, GV, RF, dimR >

GridFunction implemented by a member function of some class.

   \tparam Member   Member function pointer type.
   \tparam Class    Type of the class containing the member.
   \tparam GV       The type of the GridView
   \tparam RF       The type of the range field
   \tparam dimRange The dimension of the Range.

   The member function must support the signature
   \code

(obj.*member)(typename GV::template Codim<0>::Entity &e, const FieldVector<typename GV::ctype, GV::dimension> &xl, FieldVector<RF, dimRange> &y) const;

Member Typedef Documentation

◆ GridViewType

typedef T::GridViewType Dune::PDELab::GridFunctionBase< GridFunctionTraits< GV, RF, 1, FieldVector< RF, 1 > > , MemberFunctionToGridFunctionAdaptor< Member, Class, GV, RF, 1 > >::GridViewType
inherited

Type of the GridView.

◆ ImplementationTag

typedef GridFunctionTag Dune::PDELab::GridFunctionBase< GridFunctionTraits< GV, RF, 1, FieldVector< RF, 1 > > , MemberFunctionToGridFunctionAdaptor< Member, Class, GV, RF, 1 > >::ImplementationTag
inherited

◆ Output

using Dune::PDELab::GridFunctionBase< GridFunctionTraits< GV, RF, 1, FieldVector< RF, 1 > > , MemberFunctionToGridFunctionAdaptor< Member, Class, GV, RF, 1 > >::Output = typename Base::Output
inherited

◆ Traits

template<class Member , class Class , class GV , class RF , std::size_t dimR = 1>
typedef GridFunctionTraits< GV, RF, dimR, FieldVector<RF, dimR> > Dune::PDELab::MemberFunctionToGridFunctionAdaptor< Member, Class, GV, RF, dimR >::Traits

export traits class

Constructor & Destructor Documentation

◆ MemberFunctionToGridFunctionAdaptor()

template<class Member , class Class , class GV , class RF , std::size_t dimR = 1>
Dune::PDELab::MemberFunctionToGridFunctionAdaptor< Member, Class, GV, RF, dimR >::MemberFunctionToGridFunctionAdaptor ( const Class &  obj_,
Member  member_,
const GV &  gv_ 
)
inline

Construct an adaptor object.

Parameters
obj_Class object to call the member function on.
member_Member function pointer to the member to use.
gv_The GridView to use.

This class store the obj_ and gv_ references internally and becomes invalid when they become invalid.

Member Function Documentation

◆ dataSetType()

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

Return the data set type of this function.

◆ evaluate()

template<class Member , class Class , class GV , class RF , std::size_t dimR = 1>
void Dune::PDELab::MemberFunctionToGridFunctionAdaptor< Member, Class, GV, RF, dimR >::evaluate ( const typename Traits::ElementType e,
const typename Traits::DomainType x,
typename Traits::RangeType y 
) const
inline

◆ getGridView()

template<class Member , class Class , class GV , class RF , std::size_t dimR = 1>
const GV& Dune::PDELab::MemberFunctionToGridFunctionAdaptor< Member, Class, GV, RF, dimR >::getGridView ( ) const
inline

get reference to the internal gridview.

◆ 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: