libMesh
Public Member Functions | Protected Attributes | Private Attributes | List of all members
libMesh::MeshlessInterpolationFunction Class Reference

#include <meshless_interpolation_function.h>

Inheritance diagram for libMesh::MeshlessInterpolationFunction:
[legend]

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

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

Constructor.

Requires a MeshlessInterpolation object.

Definition at line 57 of file meshless_interpolation_function.h.

58  :
59  _mfi (mfi),
60  _mutex(mutex)
61  {}

Member Function Documentation

◆ clear()

void libMesh::MeshlessInterpolationFunction::clear ( )
virtual

Clears the function.

Reimplemented from libMesh::FunctionBase< Number >.

Definition at line 137 of file meshless_interpolation_function.h.

138 {
139 }

◆ clone()

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

Returns a new deep copy of the function.

Implements libMesh::FunctionBase< Number >.

Definition at line 145 of file meshless_interpolation_function.h.

References _mfi, and _mutex.

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

◆ component()

Number libMesh::FunctionBase< Number >::component ( unsigned int  i,
const Point p,
Real  time = 0. 
)
virtualinherited
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 SolutionFunction, SolutionFunction, and SolutionFunction.

Definition at line 227 of file function_base.h.

230 {
231  DenseVector<Output> outvec(i+1);
232  (*this)(p, time, outvec);
233  return outvec(i);
234 }

◆ init()

void libMesh::MeshlessInterpolationFunction::init ( )
virtual

The actual initialization process.

Reimplemented from libMesh::FunctionBase< Number >.

Definition at line 130 of file meshless_interpolation_function.h.

131 {
132 }

◆ initialized()

bool libMesh::FunctionBase< Number >::initialized ( ) const
inherited
Returns
true when this object is properly initialized and ready for use, false otherwise.

Definition at line 205 of file function_base.h.

206 {
207  return (this->_initialized);
208 }
bool _initialized
When init() was called so that everything is ready for calls to operator() (...), then this bool is t...

◆ is_time_dependent()

bool libMesh::FunctionBase< Number >::is_time_dependent ( ) const
inherited
Returns
true when the function this object represents is actually time-dependent, false otherwise.

Definition at line 219 of file function_base.h.

220 {
221  return (this->_is_time_dependent);
222 }
bool _is_time_dependent
Cache whether or not this function is actually time-dependent.

◆ operator()() [1/3]

Number libMesh::MeshlessInterpolationFunction::operator() ( const Point p,
const Real  time = 0. 
)
virtual
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.

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

103 {
104  _pts.clear();
105  _pts.push_back(p);
106  _vals.resize(1);
107 
108  Threads::spin_mutex::scoped_lock lock(_mutex);
109 
111  _pts, _vals);
112 
113  return _vals.front();
114 }
const std::vector< std::string > & field_variables() const
virtual void interpolate_field_data(const std::vector< std::string > &field_names, const std::vector< Point > &tgt_pts, std::vector< Number > &tgt_vals) const =0
Interpolate source data at target points.

◆ operator()() [2/3]

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

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

Implements libMesh::FunctionBase< Number >.

Definition at line 119 of file meshless_interpolation_function.h.

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

122 {
123  output.resize(1);
124  output(0) = (*this)(p, time);
125 }
void resize(const unsigned int n)
Resize the vector.
Definition: dense_vector.h:355

◆ operator()() [3/3]

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

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.

242 {
243  // Call the time-dependent function with t=0.
244  this->operator()(p, 0., output);
245 }
virtual Number operator()(const Point &p, const Real time=0.)=0

◆ set_is_time_dependent()

void libMesh::FunctionBase< Number >::set_is_time_dependent ( bool  is_time_dependent)
inherited

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.

213 {
215 }
bool _is_time_dependent
Cache whether or not this function is actually 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 file: