libMesh::MeshlessInterpolationFunction Class Reference

#include <meshless_interpolation_function.h>

Inheritance diagram for libMesh::MeshlessInterpolationFunction:

Public Member Functions
	MeshlessInterpolationFunction (const MeshfreeInterpolation &mfi, Threads::spin_mutex &mutex)
	Constructor. More...
void	init ()
	The actual initialization process. More...
void	clear ()
	Clears the function. More...
virtual std::unique_ptr< FunctionBase< Number > >	clone () const
	Returns a new deep copy of the function. More...
Number	operator() (const Point &p, const Real time=0.)
void	operator() (const Point &p, const Real time, DenseVector< Number > &output)
	Like before, but returns the values in a writable reference. More...
	MeshlessInterpolationFunction (const MeshfreeInterpolation &mfi, Threads::spin_mutex &mutex)
	MeshlessInterpolationFunction (MeshlessInterpolationFunction &&)=default
	The move/copy ctor and destructor are defaulted for this class. More...
	MeshlessInterpolationFunction (const MeshlessInterpolationFunction &)=default
virtual	~MeshlessInterpolationFunction ()=default
MeshlessInterpolationFunction &	operator= (const MeshlessInterpolationFunction &)=delete
	This class contains const references so it can't be assigned. More...
MeshlessInterpolationFunction &	operator= (MeshlessInterpolationFunction &&)=delete
void	init ()
	The actual initialization process. More...
void	clear ()
	Clears the function. More...
virtual std::unique_ptr< FunctionBase< Number > >	clone () const
Number	operator() (const Point &p, const Real)
void	operator() (const Point &p, const Real time, DenseVector< Number > &output)
	Evaluation function for time-dependent vector-valued functions. More...
void	operator() (const Point &p, DenseVector< Number > &output)
	Evaluation function for time-independent vector-valued functions. More...
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. 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
const MeshfreeInterpolation &	_mfi
std::vector< Point >	_pts
std::vector< Number >	_vals
Threads::spin_mutex &	_mutex

Detailed Description

Definition at line 44 of file meshless_interpolation_function.h.

Constructor & Destructor Documentation

MeshlessInterpolationFunction() [1/4]

libMesh::MeshlessInterpolationFunction::MeshlessInterpolationFunction ( const MeshfreeInterpolation &  mfi, Threads::spin_mutex &  mutex  )

inline

Constructor.

Requires a MeshlessInterpolation object.

Definition at line 57 of file meshless_interpolation_function.h.

                                                            :
    _mfi (mfi),
    _mutex(mutex)
  {}

MeshlessInterpolationFunction() [2/4]

libMesh::MeshlessInterpolationFunction::MeshlessInterpolationFunction ( const MeshfreeInterpolation &  mfi, Threads::spin_mutex &  mutex  )

inline

Definition at line 44 of file meshfree_solution_transfer.C.

                                                            :
    _mfi(mfi),
    _mutex(mutex)
  {}

MeshlessInterpolationFunction() [3/4]

libMesh::MeshlessInterpolationFunction::MeshlessInterpolationFunction ( MeshlessInterpolationFunction &&  )

default

The move/copy ctor and destructor are defaulted for this class.

MeshlessInterpolationFunction() [4/4]

libMesh::MeshlessInterpolationFunction::MeshlessInterpolationFunction ( const MeshlessInterpolationFunction &  )

default

~MeshlessInterpolationFunction()

virtual libMesh::MeshlessInterpolationFunction::~MeshlessInterpolationFunction ( )

virtualdefault

Member Function Documentation

clear() [1/2]

void libMesh::MeshlessInterpolationFunction::clear ( )

inlinevirtual

Clears the function.

Reimplemented from libMesh::FunctionBase< Number >.

Definition at line 64 of file meshfree_solution_transfer.C.

{}

clear() [2/2]

void libMesh::MeshlessInterpolationFunction::clear ( )

inlinevirtual

Clears the function.

Reimplemented from libMesh::FunctionBase< Number >.

Definition at line 137 of file meshless_interpolation_function.h.

{
}

clone() [1/2]

virtual std::unique_ptr<FunctionBase<Number> > libMesh::MeshlessInterpolationFunction::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 meshfree_solution_transfer.C.

  {
    return libmesh_make_unique<MeshlessInterpolationFunction>(_mfi, _mutex);
  }

References _mfi, and _mutex.

clone() [2/2]

std::unique_ptr< FunctionBase< Number > > libMesh::MeshlessInterpolationFunction::clone ( ) const

inlinevirtual

Returns a new deep copy of the function.

Implements libMesh::FunctionBase< Number >.

Definition at line 145 of file meshless_interpolation_function.h.

{
  return libmesh_make_unique<MeshlessInterpolationFunction>(_mfi, _mutex);
}

References _mfi, and _mutex.

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.

Reimplemented in TripleFunction, SolutionFunction, SolutionFunction, and SolutionFunction.

Definition at line 227 of file function_base.h.

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

init() [1/2]

void libMesh::MeshlessInterpolationFunction::init ( )

inlinevirtual

The actual initialization process.

Reimplemented from libMesh::FunctionBase< Number >.

Definition at line 63 of file meshfree_solution_transfer.C.

{}

init() [2/2]

void libMesh::MeshlessInterpolationFunction::init ( )

inlinevirtual

The actual initialization process.

Reimplemented from libMesh::FunctionBase< Number >.

Definition at line 130 of file meshless_interpolation_function.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 205 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 219 of file function_base.h.

{
  return (this->_is_time_dependent);
}

operator()() [1/5]

void libMesh::MeshlessInterpolationFunction::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 86 of file meshfree_solution_transfer.C.

  {
    output.resize(1);
    output(0) = (*this)(p,time);
    return;
  }

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

operator()() [2/5]

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

inlinevirtual

Like before, but returns the values in a writable reference.

Implements libMesh::FunctionBase< Number >.

Definition at line 119 of file meshless_interpolation_function.h.

{
  output.resize(1);
  output(0) = (*this)(p, time);
}

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

operator()() [3/5]

Number libMesh::MeshlessInterpolationFunction::operator() ( const Point &  p, const Real  time = 0.  )

inlinevirtual

Returns

the value at point p and time time, which defaults to zero.

Implements libMesh::FunctionBase< Number >.

Definition at line 101 of file meshless_interpolation_function.h.

{
  _pts.clear();
  _pts.push_back(p);
  _vals.resize(1);
 
  Threads::spin_mutex::scoped_lock lock(_mutex);
 
  _mfi.interpolate_field_data (_mfi.field_variables(),
                               _pts, _vals);
 
  return _vals.front();
}

References _mfi, _mutex, _pts, _vals, libMesh::MeshfreeInterpolation::field_variables(), and libMesh::MeshfreeInterpolation::interpolate_field_data().

operator()() [4/5]

Number libMesh::MeshlessInterpolationFunction::operator() ( const Point &  p, const  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< Number >.

Definition at line 71 of file meshfree_solution_transfer.C.

  {
    _pts.clear();
    _pts.push_back(p);
    _vals.resize(1);
 
    Threads::spin_mutex::scoped_lock lock(_mutex);
 
    _mfi.interpolate_field_data(_mfi.field_variables(), _pts, _vals);
 
    return _vals.front();
  }

References _mfi, _mutex, _pts, _vals, libMesh::MeshfreeInterpolation::field_variables(), and libMesh::MeshfreeInterpolation::interpolate_field_data().

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

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

operator=() [1/2]

MeshlessInterpolationFunction& libMesh::MeshlessInterpolationFunction::operator= ( const MeshlessInterpolationFunction &  )

delete

This class contains const references so it can't be assigned.

operator=() [2/2]

MeshlessInterpolationFunction& libMesh::MeshlessInterpolationFunction::operator= ( MeshlessInterpolationFunction &&  )

delete

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 212 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 179 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 184 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 173 of file function_base.h.

_mfi

const MeshfreeInterpolation & libMesh::MeshlessInterpolationFunction::_mfi

private

Definition at line 47 of file meshless_interpolation_function.h.

Referenced by clone(), and operator()().

_mutex

Threads::spin_mutex & libMesh::MeshlessInterpolationFunction::_mutex

private

Definition at line 50 of file meshless_interpolation_function.h.

Referenced by clone(), and operator()().

_pts

std::vector< Point > libMesh::MeshlessInterpolationFunction::_pts

mutableprivate

Definition at line 48 of file meshless_interpolation_function.h.

Referenced by operator()().

_vals

std::vector< Number > libMesh::MeshlessInterpolationFunction::_vals

mutableprivate

Definition at line 49 of file meshless_interpolation_function.h.

Referenced by operator()().

---

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

• examples/miscellaneous/miscellaneous_ex8/meshless_interpolation_function.h
• src/solution_transfer/meshfree_solution_transfer.C