Wraps a function pointer into a FunctionBase object. More...

#include <analytic_function.h>

Inheritance diagram for libMesh::AnalyticFunction< Output >:

Public Types
typedef Output(*	OutputFunction) (const Point &p, const Real time)
	Scalar return value function pointer type. More...

typedef void(*	OutputVectorFunction) (DenseVector< Output > &output, const Point &p, const Real time)
	Vector return value function pointer type. More...

Public Member Functions
	AnalyticFunction (OutputFunction fptr)
	Constructor. More...

	AnalyticFunction (OutputVectorFunction fptr)
	Constructor. More...

	AnalyticFunction (AnalyticFunction &&)=default
	The 5 special functions can be defaulted for this class. More...

	AnalyticFunction (const AnalyticFunction &)=default

AnalyticFunction &	operator= (const AnalyticFunction &)=default

AnalyticFunction &	operator= (AnalyticFunction &&)=default

virtual	~AnalyticFunction ()=default

virtual void	init () override
	The actual initialization process. More...

virtual void	clear () override
	Clears the function. More...

virtual std::unique_ptr< FunctionBase< Output > >	clone () const override

virtual Output	operator() (const Point &p, const Real time=0.) override

virtual void	operator() (const Point &p, const Real time, DenseVector< Output > &output) override
	Evaluation function for time-dependent vector-valued functions. More...

void	operator() (const Point &p, DenseVector< Output > &output)
	Evaluation function for time-independent vector-valued functions. More...

virtual Output	component (unsigned int i, const Point &p, Real time=0.)

bool	initialized () const

void	set_is_time_dependent (bool is_time_dependent)
	Function to set whether this is a time-dependent function or not. More...

bool	is_time_dependent () const

Public Attributes
OutputFunction	_number_fptr
	Pointer to user-provided function that computes the boundary values when an analytical expression is available. More...

OutputVectorFunction	_vector_fptr
	Pointer to user-provided vector valued function. More...

Protected Attributes
const FunctionBase *	_master
	Const pointer to our master, initialized to `nullptr`. More...

bool	_initialized
	When `init()` was called so that everything is ready for calls to `operator()` (...), then this `bool` is true. More...

bool	_is_time_dependent
	Cache whether or not this function is actually time-dependent. More...

Detailed Description

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

Wraps a function pointer into a FunctionBase object.

This class provides function-like objects for which an analytical expression can be provided. The user may either provide a function pointer that returns a vector or a number. All overridden virtual functions are documented in function_base.h.

Author: Daniel Dreyer

Date: 2003

Definition at line 48 of file analytic_function.h.

Member Typedef Documentation

◆ OutputFunction

template<typename Output = Number>

typedef Output(* libMesh::AnalyticFunction< Output >::OutputFunction) (const Point &p, const Real time)

Scalar return value function pointer type.

Definition at line 53 of file analytic_function.h.

◆ OutputVectorFunction

template<typename Output = Number>

typedef void(* libMesh::AnalyticFunction< Output >::OutputVectorFunction) (DenseVector< Output > &output, const Point &p, const Real time)

Vector return value function pointer type.

Definition at line 62 of file analytic_function.h.

Constructor & Destructor Documentation

◆ AnalyticFunction() [1/4]

template<typename Output >

libMesh::AnalyticFunction< Output >::AnalyticFunction ( OutputFunction fptr )

Constructor.

Takes a function pointer for scalar return values.

Definition at line 134 of file analytic_function.h.

                                                                :
   FunctionBase<Output> (),
   _number_fptr (fptr),
   _vector_fptr (nullptr)
 {
   libmesh_assert(fptr);
   this->_initialized = true;
 }

References libMesh::FunctionBase< Output >::_initialized, fptr(), and libMesh::libmesh_assert().

◆ AnalyticFunction() [2/4]

template<typename Output >

libMesh::AnalyticFunction< Output >::AnalyticFunction ( OutputVectorFunction fptr )

inline

Constructor.

Takes a function pointer for vector valued functions.

Definition at line 147 of file analytic_function.h.

                                                                      :
   FunctionBase<Output> (),
   _number_fptr (nullptr),
   _vector_fptr (fptr)
 {
   libmesh_assert(fptr);
   this->_initialized = true;
 }

References libMesh::FunctionBase< Output >::_initialized, fptr(), and libMesh::libmesh_assert().

◆ AnalyticFunction() [3/4]

template<typename Output = Number>

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

default

The 5 special functions can be defaulted for this class.

◆ AnalyticFunction() [4/4]

template<typename Output = Number>

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

default

◆ ~AnalyticFunction()

template<typename Output = Number>

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

virtualdefault

Member Function Documentation

◆ clear()

template<typename Output >

void libMesh::AnalyticFunction< Output >::clear ( )

inlineoverridevirtual

Clears the function.

Reimplemented from libMesh::FunctionBase< Output >.

Definition at line 172 of file analytic_function.h.

 {
   // We probably need a method to reset these later...
   _number_fptr = nullptr;
   _vector_fptr = nullptr;
  
   // definitely not ready
   this->_initialized = false;
 }

◆ clone()

template<typename Output >

std::unique_ptr< FunctionBase< Output > > libMesh::AnalyticFunction< 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::FunctionBase< Output >.

Definition at line 187 of file analytic_function.h.

 {
   return std::unique_ptr<FunctionBase<Output>>
     ( _number_fptr ?
       new AnalyticFunction<Output>(_number_fptr) :
       new AnalyticFunction<Output>(_vector_fptr) );
 }

◆ component()

template<typename Output >

Output libMesh::FunctionBase< Output >::component	(	unsigned int	i,
		const Point &	p,
		Real	time = `0.`
	)

inlinevirtualinherited

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 in TripleFunction, libMesh::WrappedFunction< Output >, libMesh::CompositeFunction< Output >, libMesh::ParsedFunction< Output, OutputGradient >, libMesh::ParsedFunction< T >, SolutionGradient, SolutionGradient, SolutionGradient, SolutionFunction, SolutionFunction, and SolutionFunction.

Definition at line 227 of file function_base.h.

 {
   DenseVector<Output> outvec(i+1);
   (*this)(p, time, outvec);
   return outvec(i);
 }

◆ init()

template<typename Output >

void libMesh::AnalyticFunction< Output >::init ( )

overridevirtual

The actual initialization process.

Reimplemented from libMesh::FunctionBase< Output >.

Definition at line 159 of file analytic_function.h.

 {
   // dumb double-test
   libmesh_assert ((_number_fptr != nullptr) || (_vector_fptr != nullptr));
  
   // definitely ready
   this->_initialized = true;
 }

References libMesh::libmesh_assert().

◆ initialized()

template<typename Output >

bool libMesh::FunctionBase< Output >::initialized ( ) const

inlineinherited

Returns: true when this object is properly initialized and ready for use, false otherwise.

Definition at line 205 of file function_base.h.

 {
   return (this->_initialized);
 }

◆ is_time_dependent()

template<typename Output >

bool libMesh::FunctionBase< Output >::is_time_dependent ( ) const

inlineinherited

Returns: true when the function this object represents is actually time-dependent, false otherwise.

Definition at line 219 of file function_base.h.

 {
   return (this->_is_time_dependent);
 }

Referenced by libMesh::CompositeFunction< Output >::attach_subfunction(), ParsedFunctionTest::testTimeDependence(), and CompositeFunctionTest::testTimeDependence().

◆ operator()() [1/3]

template<typename Output >

void libMesh::AnalyticFunction< Output >::operator()	(	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::FunctionBase< Output >.

Definition at line 122 of file analytic_function.h.

 {
   libmesh_assert (this->initialized());
   this->_vector_fptr(output, p, time);
   return;
 }

References libMesh::initialized(), and libMesh::libmesh_assert().

◆ operator()() [2/3]

template<typename Output >

Output libMesh::AnalyticFunction< Output >::operator()	(	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::FunctionBase< Output >.

Definition at line 111 of file analytic_function.h.

 {
   libmesh_assert (this->initialized());
   return (this->_number_fptr(p, time));
 }

References libMesh::initialized(), and libMesh::libmesh_assert().

◆ operator()() [3/3]

template<typename Output>

void libMesh::FunctionBase< Output >::operator()	(	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 240 of file function_base.h.

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

◆ operator=() [1/2]

template<typename Output = Number>

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

default

◆ operator=() [2/2]

template<typename Output = Number>

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

default

◆ set_is_time_dependent()

template<typename Output >

void libMesh::FunctionBase< Output >::set_is_time_dependent ( bool is_time_dependent )

inlineinherited

Function to set whether this is a time-dependent function or not.

This is intended to be only used by subclasses who cannot natively determine time-dependence. In such a case, this function should be used immediately following construction.

Definition at line 212 of file function_base.h.

 {
   this->_is_time_dependent = is_time_dependent;
 }

Member Data Documentation

◆ _initialized

template<typename Output = Number>

bool libMesh::FunctionBase< Output >::_initialized

protectedinherited

When init() was called so that everything is ready for calls to operator() (...), then this bool is true.

Definition at line 179 of file function_base.h.

Referenced by libMesh::AnalyticFunction< Output >::AnalyticFunction(), libMesh::ConstFunction< Output >::ConstFunction(), and libMesh::WrappedFunction< Output >::WrappedFunction().

◆ _is_time_dependent

template<typename Output = Number>

bool libMesh::FunctionBase< Output >::_is_time_dependent

protectedinherited

Cache whether or not this function is actually time-dependent.

Definition at line 184 of file function_base.h.

Referenced by libMesh::CompositeFunction< Output >::attach_subfunction(), and libMesh::ConstFunction< Output >::ConstFunction().

◆ _master

template<typename Output = Number>

const FunctionBase* libMesh::FunctionBase< Output >::_master

protectedinherited

Const pointer to our master, initialized to nullptr.

There may be cases where multiple functions are required, but to save memory, one master handles some centralized data.

Definition at line 173 of file function_base.h.

◆ _number_fptr

template<typename Output = Number>

OutputFunction libMesh::AnalyticFunction< Output >::_number_fptr

Pointer to user-provided function that computes the boundary values when an analytical expression is available.

Definition at line 84 of file analytic_function.h.

◆ _vector_fptr

template<typename Output = Number>

OutputVectorFunction libMesh::AnalyticFunction< Output >::_vector_fptr

Pointer to user-provided vector valued function.

Definition at line 89 of file analytic_function.h.

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

include/numerics/analytic_function.h

Public Types

Public Member Functions

Public Attributes

Protected Attributes

Detailed Description

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

Member Typedef Documentation

◆ OutputFunction

◆ OutputVectorFunction

Constructor & Destructor Documentation

◆ AnalyticFunction() [1/4]

◆ AnalyticFunction() [2/4]

◆ AnalyticFunction() [3/4]

◆ AnalyticFunction() [4/4]

◆ ~AnalyticFunction()

Member Function Documentation

◆ clear()

◆ clone()

◆ component()

◆ init()

◆ initialized()

◆ is_time_dependent()

◆ operator()() [1/3]

◆ operator()() [2/3]

◆ operator()() [3/3]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ set_is_time_dependent()

Member Data Documentation

◆ _initialized

◆ _is_time_dependent

◆ _master

◆ _number_fptr

◆ _vector_fptr

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