Cardinal
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
NearestPointReceiver Class Reference

#include <NearestPointReceiver.h>

Inheritance diagram for NearestPointReceiver:
[legend]

Public Member Functions

 NearestPointReceiver (const InputParameters &parameters)
 
virtual ~NearestPointReceiver ()
 
virtual void initialize () override
 
virtual void execute () override
 
virtual void finalize () override
 
virtual Real spatialValue (const Point &p) const override
 
const std::vector< Point > & positions ()
 
void setValues (const std::vector< Real > &values)
 

Static Public Member Functions

static InputParameters validParams ()
 

Protected Member Functions

unsigned int nearestPosition (const Point &p) const
 

Protected Attributes

const std::vector< Point > & _positions
 
std::vector< Real > _data
 

Detailed Description

Allows for setting values that are associated with points in space. The spatialValue() function will then return the nearest value.

Constructor & Destructor Documentation

◆ NearestPointReceiver()

NearestPointReceiver::NearestPointReceiver ( const InputParameters &  parameters)

◆ ~NearestPointReceiver()

NearestPointReceiver::~NearestPointReceiver ( )
virtual

Member Function Documentation

◆ execute()

void NearestPointReceiver::execute ( )
overridevirtual

◆ finalize()

virtual void NearestPointReceiver::finalize ( )
inlineoverridevirtual

◆ initialize()

virtual void NearestPointReceiver::initialize ( )
inlineoverridevirtual

◆ nearestPosition()

unsigned int NearestPointReceiver::nearestPosition ( const Point &  p) const
protected

Find the position that is nearest to the point

◆ positions()

const std::vector<Point>& NearestPointReceiver::positions ( )
inline

◆ setValues()

void NearestPointReceiver::setValues ( const std::vector< Real > &  values)

◆ spatialValue()

Real NearestPointReceiver::spatialValue ( const Point &  p) const
overridevirtual

◆ validParams()

InputParameters NearestPointReceiver::validParams ( )
static

Member Data Documentation

◆ _data

std::vector<Real> NearestPointReceiver::_data
protected

◆ _positions

const std::vector<Point>& NearestPointReceiver::_positions
protected

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