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

ConstFunction that simply returns 0. More...

#include <zero_function.h>

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

Public Member Functions

 ZeroFunction ()
 
 ZeroFunction (ZeroFunction &&)=default
 The 5 special functions can be defaulted for this class. More...
 
 ZeroFunction (const ZeroFunction &)=default
 
ZeroFunctionoperator= (const ZeroFunction &)=default
 
ZeroFunctionoperator= (ZeroFunction &&)=default
 
virtual ~ZeroFunction ()=default
 
virtual std::unique_ptr< FunctionBase< Output > > clone () const override
 
virtual Output operator() (const Point &, const Real=0) override
 
virtual void operator() (const Point &, const Real, 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 void init ()
 The actual initialization process. More...
 
virtual void clear ()
 Clears the function. 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
 

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::ZeroFunction< Output >

ConstFunction that simply returns 0.

Author
Roy Stogner
Date
2012 ConstFunction that simply returns 0.

Definition at line 36 of file zero_function.h.

Constructor & Destructor Documentation

◆ ZeroFunction() [1/3]

template<typename Output = Number>
libMesh::ZeroFunction< Output >::ZeroFunction ( )

Definition at line 39 of file zero_function.h.

39 : ConstFunction<Output>(0) {}

◆ ZeroFunction() [2/3]

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

The 5 special functions can be defaulted for this class.

◆ ZeroFunction() [3/3]

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

◆ ~ZeroFunction()

template<typename Output = Number>
virtual libMesh::ZeroFunction< Output >::~ZeroFunction ( )
virtualdefault

Member Function Documentation

◆ clear()

template<typename Output = Number>
virtual void libMesh::FunctionBase< Output >::clear ( )
virtualinherited

◆ clone()

template<typename Output = Number>
virtual std::unique_ptr<FunctionBase<Output> > libMesh::ZeroFunction< 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.

Reimplemented from libMesh::ConstFunction< Output >.

Definition at line 50 of file zero_function.h.

51  {
52  return libmesh_make_unique<ZeroFunction<Output>>();
53  }

◆ 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, SolutionGradient, SolutionGradient, libMesh::WrappedFunction< Output >, SolutionFunction, SolutionFunction, and SolutionFunction.

Definition at line 227 of file function_base.h.

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

◆ init()

template<typename Output = Number>
virtual void libMesh::FunctionBase< Output >::init ( )
virtualinherited

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

206 {
207  return (this->_initialized);
208 }
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 219 of file function_base.h.

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

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

◆ operator()() [1/3]

template<typename Output = Number>
virtual Output libMesh::ConstFunction< Output >::operator() ( const Point p,
const Real  time = 0 
)
overridevirtualinherited
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 61 of file const_function.h.

References libMesh::ConstFunction< Output >::_c.

63  { return _c; }

◆ operator()() [2/3]

template<typename Output = Number>
virtual void libMesh::ConstFunction< Output >::operator() ( const Point p,
const Real  time,
DenseVector< Output > &  output 
)
overridevirtualinherited

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 65 of file const_function.h.

References libMesh::ConstFunction< Output >::_c, and libMesh::DenseVector< T >::size().

68  {
69  unsigned int size = output.size();
70  for (unsigned int i=0; i != size; ++i)
71  output(i) = _c;
72  }
virtual unsigned int size() const override
Definition: dense_vector.h:92

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

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

◆ operator=() [1/2]

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

◆ operator=() [2/2]

template<typename Output = Number>
ZeroFunction& libMesh::ZeroFunction< Output >::operator= ( ZeroFunction< 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 212 of file function_base.h.

213 {
215 }
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 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.


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