libMesh::WrappedFunctor< Output > Class Template Reference

This class provides a wrapper with which to evaluate a (libMesh-style) function pointer in a FunctionBase-compatible interface. More...

#include <wrapped_functor.h>

Inheritance diagram for libMesh::WrappedFunctor< Output >:

Public Member Functions
	WrappedFunctor (const FunctionBase< Output > &func)
	Constructor to wrap FunctionBase functors in a FEMFunctionBase compatible shim. More...
	WrappedFunctor (const System &sys, Output fptr(const Point &p, const Parameters &parameters, const std::string &sys_name, const std::string &unknown_name)=nullptr, const Parameters *parameters=nullptr, unsigned int varnum=0)
	Constructor to wrap scalar-valued function pointers. More...
	WrappedFunctor (const WrappedFunctor &)=delete
	This class can't be copy constructed or assigned because it contains a unique_ptr member. More...
WrappedFunctor &	operator= (const WrappedFunctor &)=delete
	WrappedFunctor (WrappedFunctor &&)=default
	The remaining 5 special functions can be defaulted. More...
WrappedFunctor &	operator= (WrappedFunctor &&)=default
virtual	~WrappedFunctor ()=default
virtual void	init () override
	Any post-construction initialization. More...
virtual void	init_context (const FEMContext &c) override
	Tell the context we don't need anything from it. More...
virtual std::unique_ptr< FEMFunctionBase< Output > >	clone () const override
virtual Output	operator() (const FEMContext &, const Point &p, const Real time=0.) override
virtual void	operator() (const FEMContext &, const Point &p, const Real time, DenseVector< Output > &output) override
	Evaluation function for time-dependent vector-valued functions. More...
virtual Output	component (const FEMContext &, unsigned int i, const Point &p, Real time=0.) override
void	operator() (const FEMContext &, const Point &p, DenseVector< Output > &output)
	Evaluation function for time-independent vector-valued functions. More...

Protected Attributes
std::unique_ptr< FunctionBase< Output > >	_func

Detailed Description

template<typename Output = Number>
class libMesh::WrappedFunctor< Output >

This class provides a wrapper with which to evaluate a (libMesh-style) function pointer in a FunctionBase-compatible interface.

All overridden virtual functions are documented in fem_function_base.h.

Author

Roy Stogner

Date

2015

Definition at line 47 of file wrapped_functor.h.

Constructor & Destructor Documentation

WrappedFunctor() [1/4]

template<typename Output = Number>

libMesh::WrappedFunctor< Output >::WrappedFunctor ( const FunctionBase< Output > &  func )

inline

Constructor to wrap FunctionBase functors in a FEMFunctionBase compatible shim.

Definition at line 55 of file wrapped_functor.h.

    : _func(func.clone())
  { }

WrappedFunctor() [2/4]

template<typename Output = Number>

libMesh::WrappedFunctor< Output >::WrappedFunctor ( const System &  sys, Output   fptrconst Point &p, const Parameters &parameters, const std::string &sys_name, const std::string &unknown_name = nullptr, const Parameters *  parameters = nullptr, unsigned int  varnum = 0  )

inline

Constructor to wrap scalar-valued function pointers.

Definition at line 62 of file wrapped_functor.h.

                                         :
    _func(std::make_unique<WrappedFunction<Output>>(sys, fptr, parameters, varnum)) {}

WrappedFunctor() [3/4]

template<typename Output = Number>

libMesh::WrappedFunctor< Output >::WrappedFunctor ( const WrappedFunctor< Output > &  )

delete

This class can't be copy constructed or assigned because it contains a unique_ptr member.

WrappedFunctor() [4/4]

template<typename Output = Number>

libMesh::WrappedFunctor< Output >::WrappedFunctor ( WrappedFunctor< Output > &&  )

default

The remaining 5 special functions can be defaulted.

~WrappedFunctor()

template<typename Output = Number>

virtual libMesh::WrappedFunctor< Output >::~WrappedFunctor ( )

virtualdefault

Member Function Documentation

clone()

template<typename Output = Number>

virtual std::unique_ptr<FEMFunctionBase<Output> > libMesh::WrappedFunctor< Output >::clone ( ) const

inlineoverridevirtual

Returns

A new copy of the function.

The new copy should be as "deep" as necessary to allow independent destruction and simultaneous evaluations of the copies in different threads.

Implements libMesh::FEMFunctionBase< Output >.

Definition at line 95 of file wrapped_functor.h.

  {
    return std::make_unique<WrappedFunctor<Output>>(*_func);
  }

component()

template<typename Output = Number>

virtual Output libMesh::WrappedFunctor< Output >::component ( const FEMContext &  context, unsigned int  i, const Point &  p, Real  time = 0.  )

inlineoverridevirtual

Returns

The vector component i at coordinate p and time time.

Note

Subclasses aren't required to override this, since the default implementation is based on the full vector evaluation, which is often correct.

Subclasses are recommended to override this, since the default implementation is based on a vector evaluation, which is usually unnecessarily inefficient.

Reimplemented from libMesh::FEMFunctionBase< Output >.

Definition at line 111 of file wrapped_functor.h.

References libMesh::WrappedFunctor< Output >::_func.

  { return _func->component(i, p, time); }

init()

template<typename Output = Number>

virtual void libMesh::WrappedFunctor< Output >::init ( )

inlineoverridevirtual

Any post-construction initialization.

Reimplemented from libMesh::FEMFunctionBase< Output >.

Definition at line 88 of file wrapped_functor.h.

References libMesh::WrappedFunctor< Output >::_func.

{ _func->init(); }

init_context()

template<typename Output >

void libMesh::WrappedFunctor< Output >::init_context ( const FEMContext &  c )

overridevirtual

Tell the context we don't need anything from it.

Reimplemented from libMesh::FEMFunctionBase< Output >.

Definition at line 124 of file wrapped_functor.h.

References dim, libMesh::FEMContext::elem_dimensions(), libMesh::FEMContext::get_element_fe(), libMesh::FEAbstract::get_nothing(), libMesh::make_range(), and libMesh::DiffContext::n_vars().

{
  for (auto dim : c.elem_dimensions())
    {
      for (auto v : make_range(c.n_vars()))
        {
          FEAbstract * fe;
          c.get_element_fe(v, fe, dim);
          fe->get_nothing();
        }
    }
}

operator()() [1/3]

template<typename Output = Number>

virtual Output libMesh::WrappedFunctor< Output >::operator() ( const FEMContext &  , const Point &  p, const Real  time = 0.  )

inlineoverridevirtual

Returns

The scalar function value at coordinate p and time time, which defaults to zero.

Pure virtual, so you have to override it.

Implements libMesh::FEMFunctionBase< Output >.

Definition at line 100 of file wrapped_functor.h.

References libMesh::WrappedFunctor< Output >::_func.

  { return _func->operator()(p, time); }

operator()() [2/3]

template<typename Output >

void libMesh::FEMFunctionBase< Output >::operator() ( const FEMContext &  context, const Point &  p, DenseVector< Output > &  output  )

inlineinherited

Evaluation function for time-independent vector-valued functions.

Sets output values in the passed-in output DenseVector.

Definition at line 149 of file fem_function_base.h.

{
  // Call the time-dependent function with t=0.
  this->operator()(context, p, 0., output);
}

operator()() [3/3]

template<typename Output = Number>

virtual void libMesh::WrappedFunctor< Output >::operator() ( const FEMContext &  , const Point &  p, const Real  time, DenseVector< Output > &  output  )

inlineoverridevirtual

Evaluation function for time-dependent vector-valued functions.

Sets output values in the passed-in output DenseVector.

Pure virtual, so you have to override it.

Implements libMesh::FEMFunctionBase< Output >.

Definition at line 105 of file wrapped_functor.h.

References libMesh::WrappedFunctor< Output >::_func.

  { _func->operator() (p, time, output); }

operator=() [1/2]

template<typename Output = Number>

WrappedFunctor& libMesh::WrappedFunctor< Output >::operator= ( const WrappedFunctor< Output > &  )

delete

operator=() [2/2]

template<typename Output = Number>

WrappedFunctor& libMesh::WrappedFunctor< Output >::operator= ( WrappedFunctor< Output > &&  )

default

Member Data Documentation

_func

template<typename Output = Number>

std::unique_ptr<FunctionBase<Output> > libMesh::WrappedFunctor< Output >::_func

protected

Definition at line 119 of file wrapped_functor.h.

Referenced by libMesh::WrappedFunctor< Output >::component(), libMesh::WrappedFunctor< Output >::init(), and libMesh::WrappedFunctor< Output >::operator()().

---

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

• include/numerics/wrapped_functor.h