libMesh::ConstFunction< Output > Class Template Reference

Function that returns a single value that never changes. More...

#include <const_function.h>

Inheritance diagram for libMesh::ConstFunction< Output >:

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

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

Private Attributes
Output	_c

Detailed Description

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

Function that returns a single value that never changes.

All overridden virtual functions are documented in function_base.h.

Author

Roy Stogner

Date

2012 Function that returns a single value that never changes.

Definition at line 43 of file const_function.h.

Constructor & Destructor Documentation

ConstFunction() [1/3]

template<typename Output = Number>

libMesh::ConstFunction< Output >::ConstFunction ( const Output &  c )

inlineexplicit

Definition at line 47 of file const_function.h.

References libMesh::FunctionBase< Output >::_initialized, and libMesh::FunctionBase< Output >::_is_time_dependent.

                                   : _c(c)
  {
    this->_initialized = true;
    this->_is_time_dependent = false;
  }

ConstFunction() [2/3]

template<typename Output = Number>

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

default

The 5 special functions can be defaulted for this class.

ConstFunction() [3/3]

template<typename Output = Number>

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

default

~ConstFunction()

template<typename Output = Number>

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

virtualdefault

Member Function Documentation

clear()

template<typename Output = Number>

virtual void libMesh::FunctionBase< Output >::clear ( )

inlinevirtualinherited

Clears the function.

Reimplemented in libMesh::ParsedFunction< Output, OutputGradient >, libMesh::ParsedFunction< T >, libMesh::MeshFunction, libMesh::AnalyticFunction< Output >, libMesh::MeshfreeInterpolationFunction, ExampleOneFunction, and ExampleOneFunction.

Definition at line 92 of file function_base.h.

{}

clone()

template<typename Output = Number>

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

Reimplemented in libMesh::ZeroFunction< Output >.

Definition at line 75 of file const_function.h.

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

  {
    return std::make_unique<ConstFunction<Output>>(_c);
  }

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.

The default implementation calls operator() with a DenseVector of size i+1 which will result in unexpected behaviour if operator() makes any access beyond that limit.

Reimplemented in TripleFunction, libMesh::CompositeFunction< Output >, SolutionGradient< dim >, SolutionGradient< dim >, SolutionGradient< dim >, libMesh::ParsedFunction< Output, OutputGradient >, libMesh::ParsedFunction< T >, SolutionGradient< dim >, libMesh::WrappedFunction< Output >, SolutionGradient< dim >, SolutionGradient< dim >, SolutionGradient< dim >, SolutionFunction< dim >, PeriodicQuadFunction, SolutionFunction< dim >, SolutionFunction< dim >, SolutionFunction< dim >, SolutionFunction< dim >, SolutionFunction< dim >, and SolutionFunction< dim >.

Definition at line 232 of file function_base.h.

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

init()

template<typename Output = Number>

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

inlinevirtualinherited

The actual initialization process.

Reimplemented in libMesh::ParsedFunction< Output, OutputGradient >, libMesh::ParsedFunction< T >, libMesh::MeshFunction, libMesh::AnalyticFunction< Output >, libMesh::GradientMeshFunction, libMesh::MeshfreeInterpolationFunction, ExampleOneFunction, and ExampleOneFunction.

Definition at line 87 of file function_base.h.

{}

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

Referenced by libMesh::MeshFunction::MeshFunction().

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

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

{
  return (this->_is_time_dependent);
}

operator()() [1/3]

template<typename Output = Number>

virtual Output libMesh::ConstFunction< 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 62 of file const_function.h.

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

  { return _c; }

operator()() [2/3]

template<typename Output = Number>

virtual void libMesh::ConstFunction< 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 66 of file const_function.h.

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

  {
    unsigned int size = output.size();
    for (unsigned int i=0; i != size; ++i)
      output(i) = _c;
  }

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 245 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>

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

default

operator=() [2/2]

template<typename Output = Number>

ConstFunction& libMesh::ConstFunction< Output >::operator= ( ConstFunction< 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 217 of file function_base.h.

{
  this->_is_time_dependent = is_time_dependent;
}

Member Data Documentation

_c

template<typename Output = Number>

Output libMesh::ConstFunction< Output >::_c

private

Definition at line 81 of file const_function.h.

Referenced by libMesh::ConstFunction< Output >::clone(), and libMesh::ConstFunction< Output >::operator()().

_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 184 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 189 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 178 of file function_base.h.

---

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

• include/numerics/const_function.h