SolutionFunction< dim > Class Template Reference

#include <solution_function.h>

Inheritance diagram for SolutionFunction< dim >:

Public Member Functions
	SolutionFunction ()=default
	~SolutionFunction ()=default
virtual Number	operator() (const Point &, const Real=0)
virtual void	operator() (const Point &p, const Real, DenseVector< Number > &output)
	Evaluation function for time-dependent vector-valued functions.
virtual Number	component (unsigned int component_in, const Point &p, const Real)
virtual std::unique_ptr< FunctionBase< Number > >	clone () const
	SolutionFunction (const unsigned int u_var)
	~SolutionFunction ()=default
virtual Number	operator() (const Point &, const Real=0)
virtual void	operator() (const Point &p, const Real, DenseVector< Number > &output)
	Evaluation function for time-dependent vector-valued functions.
virtual Number	component (unsigned int component_in, const Point &p, const Real)
virtual std::unique_ptr< FunctionBase< Number > >	clone () const
	SolutionFunction (const unsigned int u_var)
	~SolutionFunction ()=default
virtual Number	operator() (const Point &, const Real=0)
virtual void	operator() (const Point &p, const Real, DenseVector< Number > &output)
	Evaluation function for time-dependent vector-valued functions.
virtual Number	component (unsigned int component_in, const Point &p, const Real)
virtual std::unique_ptr< FunctionBase< Number > >	clone () const
	SolutionFunction (const unsigned int u_var)
	~SolutionFunction ()=default
virtual Number	operator() (const Point &, const Real=0)
virtual void	operator() (const Point &p, const Real, DenseVector< Number > &output)
	Evaluation function for time-dependent vector-valued functions.
virtual Number	component (unsigned int component_in, const Point &p, const Real)
virtual std::unique_ptr< FunctionBase< Number > >	clone () const
	SolutionFunction ()=default
	~SolutionFunction ()=default
virtual Number	operator() (const Point &, const Real=0)
virtual void	operator() (const Point &p, const Real, DenseVector< Number > &output)
	Evaluation function for time-dependent vector-valued functions.
virtual Number	component (unsigned int component_in, const Point &p, const Real)
virtual std::unique_ptr< FunctionBase< Number > >	clone () const
	SolutionFunction ()=default
	~SolutionFunction ()=default
virtual Number	operator() (const Point &, const Real=0) override
virtual void	operator() (const Point &p, const Real, DenseVector< Number > &output) override
	Evaluation function for time-dependent vector-valued functions.
virtual std::unique_ptr< FunctionBase< Number > >	clone () const override
virtual Number	component (unsigned int i, const Point &p, Real time=0.) override
	SolutionFunction ()=default
	~SolutionFunction ()=default
virtual Number	operator() (const Point &, const Real=0) override
virtual void	operator() (const Point &p, const Real, DenseVector< Number > &output) override
	Evaluation function for time-dependent vector-valued functions.
virtual std::unique_ptr< FunctionBase< Number > >	clone () const override
virtual Number	component (unsigned int i, const Point &p, Real time=0.) override
void	operator() (const Point &p, const Real, DenseVector< Number > &output)
	Evaluation function for time-dependent vector-valued functions.
void	operator() (const Point &p, const Real, DenseVector< Number > &output)
	Evaluation function for time-dependent vector-valued functions.
void	operator() (const Point &p, const Real, DenseVector< Number > &output)
	Evaluation function for time-dependent vector-valued functions.
void	operator() (const Point &p, const Real, DenseVector< Number > &output)
	Evaluation function for time-dependent vector-valued functions.
void	operator() (const Point &p, const Real, DenseVector< Number > &output)
	Evaluation function for time-dependent vector-valued functions.
void	operator() (const Point &p, 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.
void	operator() (const Point &p, DenseVector< Number > &output)
	Evaluation function for time-independent vector-valued functions.
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 Attributes
GradDivExactSolution	soln
const unsigned int	_u_var
LaplaceExactSolution	soln
CurlCurlExactSolution	soln
DivGradExactSolution	soln
MixedExactSolution	soln

Detailed Description

template<unsigned int dim>
class SolutionFunction< dim >

Definition at line 32 of file solution_function.h.

Constructor & Destructor Documentation

SolutionFunction() [1/7]

template<unsigned int dim>

SolutionFunction< dim >::SolutionFunction ( )

default

~SolutionFunction() [1/7]

template<unsigned int dim>

SolutionFunction< dim >::~SolutionFunction ( )

default

SolutionFunction() [2/7]

template<unsigned int dim>

SolutionFunction< dim >::SolutionFunction ( const unsigned int  u_var )

inline

Definition at line 36 of file solution_function.h.

                                              :
    _u_var(u_var) {}

~SolutionFunction() [2/7]

template<unsigned int dim>

SolutionFunction< dim >::~SolutionFunction ( )

default

SolutionFunction() [3/7]

template<unsigned int dim>

SolutionFunction< dim >::SolutionFunction ( const unsigned int  u_var )

inline

Definition at line 36 of file solution_function.h.

    : _u_var(u_var) {}

~SolutionFunction() [3/7]

template<unsigned int dim>

SolutionFunction< dim >::~SolutionFunction ( )

default

SolutionFunction() [4/7]

template<unsigned int dim>

SolutionFunction< dim >::SolutionFunction ( const unsigned int  u_var )

inline

Definition at line 36 of file solution_function.h.

    : _u_var(u_var) {}

~SolutionFunction() [4/7]

template<unsigned int dim>

SolutionFunction< dim >::~SolutionFunction ( )

default

SolutionFunction() [5/7]

template<unsigned int dim>

SolutionFunction< dim >::SolutionFunction ( )

default

~SolutionFunction() [5/7]

template<unsigned int dim>

SolutionFunction< dim >::~SolutionFunction ( )

default

SolutionFunction() [6/7]

template<unsigned int dim>

SolutionFunction< dim >::SolutionFunction ( )

default

~SolutionFunction() [6/7]

template<unsigned int dim>

SolutionFunction< dim >::~SolutionFunction ( )

default

SolutionFunction() [7/7]

template<unsigned int dim>

SolutionFunction< dim >::SolutionFunction ( )

default

~SolutionFunction() [7/7]

template<unsigned int dim>

SolutionFunction< dim >::~SolutionFunction ( )

default

Member Function Documentation

clear()

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

inlinevirtualinherited

Clears the function.

Reimplemented in ExampleOneFunction, ExampleOneFunction, libMesh::MeshfreeInterpolationFunction, and libMesh::MeshFunction.

Definition at line 92 of file function_base.h.

{}

clone() [1/7]

template<unsigned int dim>

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

inlinevirtual

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 62 of file solution_function.h.

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

clone() [2/7]

template<unsigned int dim>

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

inlinevirtual

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 66 of file solution_function.h.

  { return std::make_unique<SolutionFunction>(_u_var); }

References SolutionFunction< dim >::_u_var.

clone() [3/7]

template<unsigned int dim>

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

inlinevirtual

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 64 of file solution_function.h.

  { return std::make_unique<SolutionFunction>(_u_var); }

References SolutionFunction< dim >::_u_var.

clone() [4/7]

template<unsigned int dim>

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

inlinevirtual

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

  { return std::make_unique<SolutionFunction>(_u_var); }

References SolutionFunction< dim >::_u_var.

clone() [5/7]

template<unsigned int dim>

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

inlinevirtual

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 52 of file solution_function.h.

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

clone() [6/7]

template<unsigned int dim>

virtual std::unique_ptr< FunctionBase< Number > > SolutionFunction< dim >::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< Number >.

Definition at line 43 of file solution_function.h.

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

clone() [7/7]

template<unsigned int dim>

virtual std::unique_ptr< FunctionBase< Number > > SolutionFunction< dim >::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< Number >.

Definition at line 43 of file solution_function.h.

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

component() [1/7]

template<unsigned int dim>

Number SolutionFunction< dim >::component ( unsigned int  i, const Point &  p, const Real  time  )

inlinevirtual

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

Definition at line 53 of file solution_function.h.

  {
    DenseVector<Number> outvec(3);
    (*this)(p, 0, outvec);
    return outvec(component_in);
  }

component() [2/7]

template<unsigned int dim>

virtual Number SolutionFunction< dim >::component ( unsigned int  i, const Point &  p, const Real  time  )

inlinevirtual

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

Definition at line 58 of file solution_function.h.

  {
    const Real x=p(0), y=p(1), z=p(2);
    return soln(component_in, x, y, z);
  }

References libMesh::Real, and SolutionFunction< dim >::soln.

component() [3/7]

template<unsigned int dim>

virtual Number SolutionFunction< dim >::component ( unsigned int  i, const Point &  p, const Real  time  )

inlinevirtual

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

Definition at line 57 of file solution_function.h.

  {
    return soln(p)(component_in);
  }

References SolutionFunction< dim >::soln.

component() [4/7]

template<unsigned int dim>

virtual Number SolutionFunction< dim >::component ( unsigned int  i, const Point &  p, const Real  time  )

inlinevirtual

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

Definition at line 57 of file solution_function.h.

  {
    const Real x=p(0), y=p(1), z=p(2);
    return soln(x, y, z)(component_in);
  }

References libMesh::Real, and SolutionFunction< dim >::soln.

component() [5/7]

template<unsigned int dim>

virtual Number SolutionFunction< dim >::component ( unsigned int  i, const Point &  p, const Real  time  )

virtual

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

component() [6/7]

template<unsigned int dim>

virtual Number SolutionFunction< dim >::component ( unsigned int  i, const Point &  p, Real  time = 0.  )

inlineoverridevirtual

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

Definition at line 48 of file solution_function.h.

  {
    const auto size = dim == 2 ? 4 : 5;
    DenseVector<Number> outvec(size);
    (*this)(p, time, outvec);
    return outvec(i);
  }

References dim.

component() [7/7]

template<unsigned int dim>

virtual Number SolutionFunction< dim >::component ( unsigned int  i, const Point &  p, Real  time = 0.  )

inlineoverridevirtual

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

Definition at line 48 of file solution_function.h.

  {
    const auto size = dim == 2 ? 4 : 5;
    DenseVector<Number> outvec(size);
    (*this)(p, time, outvec);
    return outvec(i);
  }

References dim.

init()

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

inlinevirtualinherited

The actual initialization process.

Reimplemented in ExampleOneFunction, ExampleOneFunction, libMesh::MeshfreeInterpolationFunction, and libMesh::MeshFunction.

Definition at line 87 of file function_base.h.

{}

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/21]

template<unsigned int dim>

virtual Number SolutionFunction< dim >::operator() ( const Point &  p, const Real  time = 0  )

inlinevirtual

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 39 of file solution_function.h.

  { libmesh_not_implemented(); }

operator()() [2/21]

template<unsigned int dim>

virtual Number SolutionFunction< dim >::operator() ( const Point &  p, const Real  time = 0  )

inlinevirtual

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 41 of file solution_function.h.

  { libmesh_not_implemented(); }

operator()() [3/21]

template<unsigned int dim>

virtual Number SolutionFunction< dim >::operator() ( const Point &  p, const Real  time = 0  )

inlinevirtual

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 41 of file solution_function.h.

  { libmesh_not_implemented(); }

operator()() [4/21]

template<unsigned int dim>

virtual Number SolutionFunction< dim >::operator() ( const Point &  p, const Real  time = 0  )

inlinevirtual

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 41 of file solution_function.h.

  { libmesh_not_implemented(); }

operator()() [5/21]

template<unsigned int dim>

virtual Number SolutionFunction< dim >::operator() ( const Point &  p, const Real  time = 0  )

inlinevirtual

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 40 of file solution_function.h.

  { libmesh_not_implemented(); }

operator()() [6/21]

template<unsigned int dim>

virtual Number SolutionFunction< dim >::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< Number >.

Definition at line 39 of file solution_function.h.

{ libmesh_not_implemented(); }

operator()() [7/21]

template<unsigned int dim>

virtual Number SolutionFunction< dim >::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< Number >.

Definition at line 39 of file solution_function.h.

{ libmesh_not_implemented(); }

operator()() [8/21]

template<unsigned int dim>

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

inlinevirtual

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 43 of file solution_function.h.

  {
    output.zero();
    output(0) = soln(p)(0);
    output(1) = soln(p)(1);
    output(2) = soln(p)(2);
  }

References SolutionFunction< dim >::soln, and libMesh::DenseVector< T >::zero().

operator()() [9/21]

template<unsigned int dim>

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

inlinevirtual

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 45 of file solution_function.h.

  {
    output.zero();
    const Real x=p(0), y=p(1), z=p(2);
    // libMesh assumes each component of the vector-valued variable is stored
    // contiguously.
    output(_u_var)   = soln(0, x, y, z);
    output(_u_var+1) = soln(1, x, y, z);
    output(_u_var+2) = soln(2, x, y, z);
  }

References SolutionFunction< dim >::_u_var, libMesh::Real, SolutionFunction< dim >::soln, and libMesh::DenseVector< T >::zero().

operator()() [10/21]

template<unsigned int dim>

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

inlinevirtual

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 45 of file solution_function.h.

  {
    output.zero();
    // libMesh assumes each component of the vector-valued variable is stored
    // contiguously.
    output(_u_var)   = soln(p)(0);
    output(_u_var+1) = soln(p)(1);
    output(_u_var+2) = soln(p)(2);
  }

References SolutionFunction< dim >::_u_var, SolutionFunction< dim >::soln, and libMesh::DenseVector< T >::zero().

operator()() [11/21]

template<unsigned int dim>

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

inlinevirtual

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 44 of file solution_function.h.

  {
    output.zero();
    const Real x=p(0), y=p(1), z=p(2);
    // libMesh assumes each component of the vector-valued variable is stored
    // contiguously.
    output(_u_var)   = soln(x, y, z)(0);
    output(_u_var+1) = soln(x, y, z)(1);
    output(_u_var+2) = soln(x, y, z)(2);
  }

References SolutionFunction< dim >::_u_var, libMesh::Real, SolutionFunction< dim >::soln, and libMesh::DenseVector< T >::zero().

operator()() [12/21]

template<unsigned int dim>

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

virtual

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

operator()() [13/21]

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

virtual

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 61 of file solution_function.h.

{
  output.zero();
  const Real x=p(0), y=p(1);
  output(0) = soln(x, y)(0);
  output(1) = soln(x, y)(1);
  output(2) = soln.scalar(x, y);
}

References libMesh::Real, and libMesh::DenseVector< T >::zero().

operator()() [14/21]

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

virtual

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 73 of file solution_function.h.

{
  output.zero();
  const Real x=p(0), y=p(1), z=p(2);
  output(0) = soln(x, y, z)(0);
  output(1) = soln(x, y, z)(1);
  output(2) = soln(x, y, z)(2);
  output(3) = soln.scalar(x, y, z);
}

References libMesh::Real, and libMesh::DenseVector< T >::zero().

operator()() [15/21]

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

virtual

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 62 of file solution_function.h.

{
  // We should have our vector variable, our scalar variable, and our higher order scalar variable
  libmesh_assert(output.size() <= 4);
  output.zero();
  const Real x = p(0), y = p(1);
  // libMesh assumes each component of a vector-valued variable is stored
  // contiguously.
  const auto vector = soln(x, y);
  output(0) = vector(0);
  output(1) = vector(1);
  const auto scalar = soln.scalar(x, y);
  output(2) = scalar;
  output(3) = scalar;
}

References libMesh::libmesh_assert(), libMesh::Real, libMesh::DenseVector< T >::size(), and libMesh::DenseVector< T >::zero().

operator()() [16/21]

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

virtual

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 80 of file solution_function.h.

{
  // We should have our vector variable, our scalar variable, and our higher order scalar variable
  libmesh_assert(output.size() <= 5);
  output.zero();
  const Real x = p(0), y = p(1), z = p(2);
  // libMesh assumes each component of the vector-valued variable is stored
  // contiguously.
  const auto vector = soln(x, y, z);
  output(0) = vector(0);
  output(1) = vector(1);
  output(2) = vector(2);
  const auto scalar = soln.scalar(x, y, z);
  output(3) = scalar;
  output(4) = scalar;
}

References libMesh::libmesh_assert(), libMesh::Real, libMesh::DenseVector< T >::size(), and libMesh::DenseVector< T >::zero().

operator()() [17/21]

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

virtual

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 62 of file solution_function.h.

{
  // We should have our vector variable, our scalar variable, and our higher order scalar variable
  libmesh_assert(output.size() <= 4);
  output.zero();
  const Real x = p(0), y = p(1);
  // libMesh assumes each component of a vector-valued variable is stored
  // contiguously.
  const auto vector = soln(x, y);
  output(0) = vector(0);
  output(1) = vector(1);
  const auto scalar = soln.scalar(x, y);
  output(2) = scalar;
  output(3) = scalar;
}

References libMesh::libmesh_assert(), libMesh::Real, libMesh::DenseVector< T >::size(), and libMesh::DenseVector< T >::zero().

operator()() [18/21]

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

virtual

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 80 of file solution_function.h.

{
  // We should have our vector variable, our scalar variable, and our higher order scalar variable
  libmesh_assert(output.size() <= 5);
  output.zero();
  const Real x = p(0), y = p(1), z = p(2);
  // libMesh assumes each component of the vector-valued variable is stored
  // contiguously.
  const auto vector = soln(x, y, z);
  output(0) = vector(0);
  output(1) = vector(1);
  output(2) = vector(2);
  const auto scalar = soln.scalar(x, y, z);
  output(3) = scalar;
  output(4) = scalar;
}

References libMesh::libmesh_assert(), libMesh::Real, libMesh::DenseVector< T >::size(), and libMesh::DenseVector< T >::zero().

operator()() [19/21]

template<unsigned int dim>

virtual void SolutionFunction< dim >::operator() ( const Point &  p, const Real  time, DenseVector< Number > &  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< Number >.

operator()() [20/21]

template<unsigned int dim>

virtual void SolutionFunction< dim >::operator() ( const Point &  p, const Real  time, DenseVector< Number > &  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< Number >.

operator()() [21/21]

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.

_u_var

template<unsigned int dim>

const unsigned int SolutionFunction< dim >::_u_var

private

Definition at line 71 of file solution_function.h.

Referenced by SolutionFunction< dim >::clone(), and SolutionFunction< dim >::operator()().

soln [1/5]

template<unsigned int dim>

DivGradExactSolution SolutionFunction< dim >::soln

private

Definition at line 67 of file solution_function.h.

Referenced by SolutionFunction< dim >::component(), and SolutionFunction< dim >::operator()().

soln [2/5]

template<unsigned int dim>

LaplaceExactSolution SolutionFunction< dim >::soln

private

Definition at line 72 of file solution_function.h.

soln [3/5]

template<unsigned int dim>

CurlCurlExactSolution SolutionFunction< dim >::soln

private

Definition at line 70 of file solution_function.h.

soln [4/5]

template<unsigned int dim>

DivGradExactSolution SolutionFunction< dim >::soln

private

Definition at line 57 of file solution_function.h.

soln [5/5]

template<unsigned int dim>

MixedExactSolution SolutionFunction< dim >::soln

private

Definition at line 57 of file solution_function.h.

---

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

• examples/vector_fe/vector_fe_ex10/solution_function.h
• examples/vector_fe/vector_fe_ex2/solution_function.h
• examples/vector_fe/vector_fe_ex3/solution_function.h
• examples/vector_fe/vector_fe_ex4/solution_function.h
• examples/vector_fe/vector_fe_ex6/solution_function.h
• examples/vector_fe/vector_fe_ex7/solution_function.h
• examples/vector_fe/vector_fe_ex8/solution_function.h