libMesh::GradientMeshFunction Class Reference

#include <inter_mesh_projection.h>

Inheritance diagram for libMesh::GradientMeshFunction:

Public Member Functions
	GradientMeshFunction (const MeshFunction &_mesh_function)
virtual	~GradientMeshFunction ()
virtual void	init ()
	The actual initialization process. More...
virtual std::unique_ptr< FunctionBase< Gradient > >	clone () const
virtual Gradient	operator() (const Point &, const Real)
virtual void	operator() (const Point &p, const Real, DenseVector< Gradient > &output)
	Evaluation function for time-dependent vector-valued functions. More...
virtual void	clear ()
	Clears the function. More...
void	operator() (const Point &p, DenseVector< Gradient > &output)
	Evaluation function for time-independent vector-valued functions. More...
virtual Gradient	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
std::unique_ptr< MeshFunction >	mesh_function

Detailed Description

Definition at line 77 of file inter_mesh_projection.h.

Constructor & Destructor Documentation

GradientMeshFunction()

libMesh::GradientMeshFunction::GradientMeshFunction

(

const MeshFunction &

_mesh_function

)

Definition at line 23 of file inter_mesh_projection.C.

                                                                             :
  mesh_function(std::make_unique<MeshFunction>(_mesh_function))
{
  libmesh_experimental();
}

~GradientMeshFunction()

virtual libMesh::GradientMeshFunction::~GradientMeshFunction ( )

inlinevirtual

Definition at line 84 of file inter_mesh_projection.h.

{ }

Member Function Documentation

clear()

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

inlinevirtualinherited

Clears the function.

Definition at line 92 of file function_base.h.

{}

clone()

virtual std::unique_ptr<FunctionBase<Gradient> > libMesh::GradientMeshFunction::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< Gradient >.

Definition at line 88 of file inter_mesh_projection.h.

  {
    return std::make_unique<GradientMeshFunction>(*mesh_function);
  }

component()

Gradient libMesh::FunctionBase< Gradient >::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 SolutionGradient< dim >, SolutionGradient< dim >, SolutionGradient< dim >, SolutionGradient< dim >, SolutionGradient< dim >, SolutionGradient< dim >, and SolutionGradient< dim >.

Definition at line 232 of file function_base.h.

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

init()

virtual void libMesh::GradientMeshFunction::init ( )

inlinevirtual

The actual initialization process.

Reimplemented from libMesh::FunctionBase< Gradient >.

Definition at line 86 of file inter_mesh_projection.h.

Referenced by libMesh::InterMeshProjection::project_system_vectors().

{ }

initialized()

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

{
  return (this->_initialized);
}

is_time_dependent()

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

{
  return (this->_is_time_dependent);
}

operator()() [1/3]

virtual Gradient libMesh::GradientMeshFunction::operator() ( const Point &  p, const Real  time  )

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

Definition at line 93 of file inter_mesh_projection.h.

  { libmesh_not_implemented(); }

operator()() [2/3]

void libMesh::GradientMeshFunction::operator() ( const Point &  p, const Real  time, DenseVector< Gradient > &  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< Gradient >.

Definition at line 29 of file inter_mesh_projection.C.

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

{
  Real time = 0.0;
  mesh_function->gradient(p, time, output.get_values());
  return;
}

operator()() [3/3]

void libMesh::FunctionBase< Gradient >::operator() ( const Point &  p, DenseVector< Gradient > &  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);
}

set_is_time_dependent()

void libMesh::FunctionBase< Gradient >::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

_initialized

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

mesh_function

std::unique_ptr<MeshFunction> libMesh::GradientMeshFunction::mesh_function

private

Definition at line 101 of file inter_mesh_projection.h.

Referenced by operator()().

---

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

• include/systems/inter_mesh_projection.h
• src/systems/inter_mesh_projection.C