libMesh
Public Types | Public Member Functions | Public Attributes | Protected Attributes | List of all members
libMesh::AnalyticFunction< Output > Class Template Reference

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

#include <analytic_function.h>

Inheritance diagram for libMesh::AnalyticFunction< Output >:
[legend]

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
 
AnalyticFunctionoperator= (const AnalyticFunction &)=default
 
AnalyticFunctionoperator= (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.

References libMesh::FunctionBase< Output >::_initialized.

134  :
135  FunctionBase<Output> (),
136  _number_fptr (fptr),
137  _vector_fptr (nullptr)
138 {
139  libmesh_assert(fptr);
140  this->_initialized = true;
141 }
OutputFunction _number_fptr
Pointer to user-provided function that computes the boundary values when an analytical expression is ...
bool _initialized
When init() was called so that everything is ready for calls to operator() (...), then this bool is t...
OutputVectorFunction _vector_fptr
Pointer to user-provided vector valued function.

◆ AnalyticFunction() [2/4]

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

Constructor.

Takes a function pointer for vector valued functions.

Definition at line 147 of file analytic_function.h.

References libMesh::FunctionBase< Output >::_initialized.

147  :
148  FunctionBase<Output> (),
149  _number_fptr (nullptr),
150  _vector_fptr (fptr)
151 {
152  libmesh_assert(fptr);
153  this->_initialized = true;
154 }
OutputFunction _number_fptr
Pointer to user-provided function that computes the boundary values when an analytical expression is ...
bool _initialized
When init() was called so that everything is ready for calls to operator() (...), then this bool is t...
OutputVectorFunction _vector_fptr
Pointer to user-provided vector valued function.

◆ 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 ( )
overridevirtual

Clears the function.

Reimplemented from libMesh::FunctionBase< Output >.

Definition at line 172 of file analytic_function.h.

173 {
174  // We probably need a method to reset these later...
175  _number_fptr = nullptr;
176  _vector_fptr = nullptr;
177 
178  // definitely not ready
179  this->_initialized = false;
180 }
OutputFunction _number_fptr
Pointer to user-provided function that computes the boundary values when an analytical expression is ...
bool _initialized
When init() was called so that everything is ready for calls to operator() (...), then this bool is t...
OutputVectorFunction _vector_fptr
Pointer to user-provided vector valued function.

◆ clone()

template<typename Output >
std::unique_ptr< FunctionBase< Output > > libMesh::AnalyticFunction< Output >::clone ( ) const
overridevirtual
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.

188 {
189  return std::unique_ptr<FunctionBase<Output>>
190  ( _number_fptr ?
191  new AnalyticFunction<Output>(_number_fptr) :
192  new AnalyticFunction<Output>(_vector_fptr) );
193 }
OutputFunction _number_fptr
Pointer to user-provided function that computes the boundary values when an analytical expression is ...
OutputVectorFunction _vector_fptr
Pointer to user-provided vector valued function.

◆ component()

template<typename Output >
Output libMesh::FunctionBase< Output >::component ( unsigned int  i,
const Point p,
Real  time = 0. 
)
virtualinherited
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 libMesh::CompositeFunction< Output >, libMesh::ParsedFunction< Output, OutputGradient >, libMesh::ParsedFunction< T >, SolutionGradient, libMesh::WrappedFunction< Output >, SolutionGradient, SolutionGradient, SolutionFunction, SolutionFunction, and SolutionFunction.

Definition at line 228 of file function_base.h.

231 {
232  DenseVector<Output> outvec(i+1);
233  (*this)(p, time, outvec);
234  return outvec(i);
235 }

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

160 {
161  // dumb double-test
162  libmesh_assert ((_number_fptr != nullptr) || (_vector_fptr != nullptr));
163 
164  // definitely ready
165  this->_initialized = true;
166 }
OutputFunction _number_fptr
Pointer to user-provided function that computes the boundary values when an analytical expression is ...
bool _initialized
When init() was called so that everything is ready for calls to operator() (...), then this bool is t...
OutputVectorFunction _vector_fptr
Pointer to user-provided vector valued function.

◆ initialized()

template<typename Output >
bool libMesh::FunctionBase< Output >::initialized ( ) const
inherited
Returns
true when this object is properly initialized and ready for use, false otherwise.

Definition at line 206 of file function_base.h.

207 {
208  return (this->_initialized);
209 }
bool _initialized
When init() was called so that everything is ready for calls to operator() (...), then this bool is t...

◆ is_time_dependent()

template<typename Output >
bool libMesh::FunctionBase< Output >::is_time_dependent ( ) const
inherited
Returns
true when the function this object represents is actually time-dependent, false otherwise.

Definition at line 220 of file function_base.h.

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

221 {
222  return (this->_is_time_dependent);
223 }
bool _is_time_dependent
Cache whether or not this function is actually time-dependent.

◆ operator()() [1/3]

template<typename Output >
Output libMesh::AnalyticFunction< Output >::operator() ( const Point p,
const Real  time = 0. 
)
overridevirtual
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.

References libMesh::initialized().

113 {
114  libmesh_assert (this->initialized());
115  return (this->_number_fptr(p, time));
116 }
OutputFunction _number_fptr
Pointer to user-provided function that computes the boundary values when an analytical expression is ...
bool initialized() const

◆ operator()() [2/3]

template<typename Output >
void libMesh::AnalyticFunction< Output >::operator() ( const Point p,
const Real  time,
DenseVector< Output > &  output 
)
overridevirtual

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.

References libMesh::initialized().

125 {
126  libmesh_assert (this->initialized());
127  this->_vector_fptr(output, p, time);
128  return;
129 }
OutputVectorFunction _vector_fptr
Pointer to user-provided vector valued function.
bool initialized() const

◆ operator()() [3/3]

template<typename Output>
void libMesh::FunctionBase< Output >::operator() ( const Point p,
DenseVector< Output > &  output 
)
inherited

Evaluation function for time-independent vector-valued functions.

Sets output values in the passed-in output DenseVector.

Definition at line 241 of file function_base.h.

243 {
244  // Call the time-dependent function with t=0.
245  this->operator()(p, 0., output);
246 }
virtual Output operator()(const Point &p, const Real time=0.)=0

◆ operator=() [1/2]

template<typename Output = Number>
AnalyticFunction& libMesh::AnalyticFunction< Output >::operator= ( const AnalyticFunction< Output > &  )
default

◆ operator=() [2/2]

template<typename Output = Number>
AnalyticFunction& libMesh::AnalyticFunction< Output >::operator= ( AnalyticFunction< Output > &&  )
default

◆ set_is_time_dependent()

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

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 213 of file function_base.h.

214 {
216 }
bool is_time_dependent() const
bool _is_time_dependent
Cache whether or not this function is actually 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 180 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 185 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 174 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: