plask::FieldProvider< ValueT, SpaceT, ExtraArgs > Struct Template Reference

Instantiation of this template is abstract base class for provider class which provide values in points described by mesh and use interpolation. More...

#include <plask/provider/provider.hpp>

Inheritance diagram for plask::FieldProvider< ValueT, SpaceT, ExtraArgs >:

Collaboration diagram for plask::FieldProvider< ValueT, SpaceT, ExtraArgs >:

Public Types
typedef LazyData< ValueT >	ProvidedType
	Type of value provided by this (returned by operator()).
typedef SpaceT	SpaceType

Public Member Functions
const char *	name () const override
virtual ProvidedType	operator() (shared_ptr< const MeshD< SpaceT::DIM > > dst_mesh, ExtraArgs... extra_args, InterpolationMethod method) const =0
ProvidedType	operator() (shared_ptr< const MeshD< SpaceT::DIM > > dst_mesh, ExtraArgs... extra_args) const
	Call this->operator()(dst_mesh, DEFAULT).
ProvidedType	operator() (shared_ptr< const MeshD< SpaceT::DIM > > dst_mesh, std::tuple< ExtraArgs... > extra_args, InterpolationMethod method=INTERPOLATION_DEFAULT) const
Public Member Functions inherited from plask::Provider
Provider &	operator= (const Provider &)=delete
	Provider (const Provider &)=delete
	Provider ()=default
virtual	~Provider ()
	Call onDisconnect for all listeners in listeners set.
void	fireChanged ()
	Call onChange for all listeners.

Static Public Attributes
static constexpr const char *	NAME = "undefined field"
Static Public Attributes inherited from plask::Provider
static constexpr const char *	NAME = "undefined"

Additional Inherited Members
Public Attributes inherited from plask::Provider
boost::signals2::signal< void(Provider &, bool)>	changed
	Signal called when providers value has been changed or provider is being deleted.

Detailed Description

template<typename ValueT, typename SpaceT, typename... ExtraArgs>
struct plask::FieldProvider< ValueT, SpaceT, ExtraArgs >

Instantiation of this template is abstract base class for provider class which provide values in points described by mesh and use interpolation.

Definition at line 511 of file provider.hpp.

Member Typedef Documentation

ProvidedType

template<typename ValueT , typename SpaceT , typename... ExtraArgs>

typedef LazyData<ValueT> plask::FieldProvider< ValueT, SpaceT, ExtraArgs >::ProvidedType

Type of value provided by this (returned by operator()).

Definition at line 517 of file provider.hpp.

SpaceType

template<typename ValueT , typename SpaceT , typename... ExtraArgs>

typedef SpaceT plask::FieldProvider< ValueT, SpaceT, ExtraArgs >::SpaceType

Definition at line 518 of file provider.hpp.

Member Function Documentation

name()

template<typename ValueT , typename SpaceT , typename... ExtraArgs>

const char * plask::FieldProvider< ValueT, SpaceT, ExtraArgs >::name ( ) const

inlineoverridevirtual

Reimplemented from plask::Provider.

Reimplemented in plask::ProviderImpl< PropertyT, FIELD_PROPERTY, SpaceT, VariadicTemplateTypesHolder< _ExtraParams... > >.

Definition at line 514 of file provider.hpp.

operator()() [1/3]

template<typename ValueT , typename SpaceT , typename... ExtraArgs>

ProvidedType plask::FieldProvider< ValueT, SpaceT, ExtraArgs >::operator() ( shared_ptr< const MeshD< SpaceT::DIM > >  dst_mesh, ExtraArgs...  extra_args  ) const

inline

Call this->operator()(dst_mesh, DEFAULT).

Parameters

dst_mesh	set of requested points
extra_args	additional provider arguments

Returns

values in points describe by mesh dst_mesh

Definition at line 534 of file provider.hpp.

operator()() [2/3]

template<typename ValueT , typename SpaceT , typename... ExtraArgs>

virtual ProvidedType plask::FieldProvider< ValueT, SpaceT, ExtraArgs >::operator() ( shared_ptr< const MeshD< SpaceT::DIM > >  dst_mesh, ExtraArgs...  extra_args, InterpolationMethod  method  ) const

pure virtual

Parameters

dst_mesh	set of requested points
extra_args	additional provider arguments
method	method which should be use to do interpolation

Returns

values in points describe by mesh dst_mesh

operator()() [3/3]

template<typename ValueT , typename SpaceT , typename... ExtraArgs>

ProvidedType plask::FieldProvider< ValueT, SpaceT, ExtraArgs >::operator() ( shared_ptr< const MeshD< SpaceT::DIM > >  dst_mesh, std::tuple< ExtraArgs... >  extra_args, InterpolationMethod  method = INTERPOLATION_DEFAULT  ) const

inline

Parameters

dst_mesh	set of requested points
extra_args	additional provider arguments, given in tuple
method	method which should be use to do interpolation

Returns

values in points describe by mesh dst_mesh

Definition at line 544 of file provider.hpp.

Member Data Documentation

NAME

template<typename ValueT , typename SpaceT , typename... ExtraArgs>

constexpr const char* plask::FieldProvider< ValueT, SpaceT, ExtraArgs >::NAME = "undefined field"

staticconstexpr

Definition at line 513 of file provider.hpp.

---

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

• plask/provider/provider.hpp