ExampleOneFunction Class Reference

Inheritance diagram for ExampleOneFunction:

Public Member Functions
void	operator() (const Point &p, DenseVector< Number > &output)
	Evaluation function for time-independent vector-valued functions.
virtual Number	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.
bool	is_time_dependent () const

Protected Attributes
const FunctionBase *	_master
	Const pointer to our master, initialized to nullptr.
bool	_initialized
	When init() was called so that everything is ready for calls to operator() (...), then this bool is true.
bool	_is_time_dependent
	Cache whether or not this function is actually time-dependent.

Private Member Functions
virtual Number	operator() (const Point &, const Real)
virtual void	operator() (const Point &, const Real, DenseVector< Number > &output)
	Evaluation function for time-dependent vector-valued functions.
virtual void	init ()
	The actual initialization process.
virtual void	clear ()
	Clears the function.
virtual std::unique_ptr< FunctionBase< Number > >	clone () const
virtual Number	operator() (const Point &, const Real)
virtual void	operator() (const Point &, const Real, DenseVector< Number > &output)
	Evaluation function for time-dependent vector-valued functions.
virtual void	init ()
	The actual initialization process.
virtual void	clear ()
	Clears the function.
virtual std::unique_ptr< FunctionBase< Number > >	clone () const

Detailed Description

Definition at line 31 of file factoryfunction.C.

Member Function Documentation

clear() [1/2]

virtual void ExampleOneFunction::clear ( )

inlineprivatevirtual

Clears the function.

Reimplemented from libMesh::FunctionBase< Number >.

Definition at line 48 of file factoryfunction.C.

{}

clear() [2/2]

virtual void ExampleOneFunction::clear ( )

inlineprivatevirtual

Clears the function.

Reimplemented from libMesh::FunctionBase< Number >.

Definition at line 48 of file factoryfunction.C.

{}

clone() [1/2]

virtual std::unique_ptr< FunctionBase< Number > > ExampleOneFunction::clone ( ) const

inlineprivatevirtual

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

Definition at line 49 of file factoryfunction.C.

  {
    return std::make_unique<ExampleOneFunction>();
  }

clone() [2/2]

virtual std::unique_ptr< FunctionBase< Number > > ExampleOneFunction::clone ( ) const

inlineprivatevirtual

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

Definition at line 49 of file factoryfunction.C.

  {
    return std::make_unique<ExampleOneFunction>();
  }

component()

Number libMesh::FunctionBase< Number >::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 SolutionFunction< dim >, SolutionFunction< dim >, SolutionFunction< dim >, SolutionFunction< dim >, SolutionFunction< dim >, SolutionFunction< dim >, SolutionFunction< dim >, PeriodicQuadFunction, and TripleFunction.

Definition at line 145 of file function_base.h.

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

init() [1/2]

virtual void ExampleOneFunction::init ( )

inlineprivatevirtual

The actual initialization process.

Reimplemented from libMesh::FunctionBase< Number >.

Definition at line 47 of file factoryfunction.C.

{}

init() [2/2]

virtual void ExampleOneFunction::init ( )

inlineprivatevirtual

The actual initialization process.

Reimplemented from libMesh::FunctionBase< Number >.

Definition at line 47 of file factoryfunction.C.

{}

initialized()

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

inlineinherited

Returns

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

Definition at line 154 of file function_base.h.

{
  return (this->_initialized);
}

is_time_dependent()

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

inlineinherited

Returns

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

Definition at line 168 of file function_base.h.

{
  return (this->_is_time_dependent);
}

operator()() [1/5]

virtual Number ExampleOneFunction::operator() ( const Point &  p, const Real  time  )

inlineprivatevirtual

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

Definition at line 33 of file factoryfunction.C.

  {
    return 1;
  }

operator()() [2/5]

virtual Number ExampleOneFunction::operator() ( const Point &  p, const Real  time  )

inlineprivatevirtual

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

Definition at line 33 of file factoryfunction.C.

  {
    return 1;
  }

operator()() [3/5]

virtual void ExampleOneFunction::operator() ( const Point &  p, const Real  time, DenseVector< Number > &  output  )

inlineprivatevirtual

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

Definition at line 39 of file factoryfunction.C.

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

References libMesh::DenseVector< T >::size().

operator()() [4/5]

virtual void ExampleOneFunction::operator() ( const Point &  p, const Real  time, DenseVector< Number > &  output  )

inlineprivatevirtual

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

Definition at line 39 of file factoryfunction.C.

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

References libMesh::DenseVector< T >::size().

operator()() [5/5]

void libMesh::FunctionBase< Number >::operator() ( const Point &  p, DenseVector< Number > &  output  )

inlineinherited

Evaluation function for time-independent vector-valued functions.

Sets output values in the passed-in output DenseVector.

Definition at line 116 of file function_base.h.

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

set_is_time_dependent()

void libMesh::FunctionBase< Number >::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 162 of file function_base.h.

{
  this->_is_time_dependent = is_time_dependent;
}

Member Data Documentation

_initialized

bool libMesh::FunctionBase< Number >::_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.

_is_time_dependent

bool libMesh::FunctionBase< Number >::_is_time_dependent

protectedinherited

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

Definition at line 189 of file function_base.h.

_master

const FunctionBase* libMesh::FunctionBase< Number >::_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 files:

• examples/adjoints/adjoints_ex5/factoryfunction.C
• examples/adjoints/adjoints_ex7/factoryfunction.C