NekPointValue Class Reference

#include <NekPointValue.h>

Inheritance diagram for NekPointValue:

Public Member Functions
	NekPointValue (const InputParameters &parameters)
virtual Real	getValue () const override
virtual void	execute () override
virtual void	initialize () override
const field::NekFieldEnum &	field () const

Static Public Member Functions
static InputParameters	validParams ()

Protected Attributes
const Point &	_point
	Point where the field will be evaluated.
Real	_value
	The value of the variable at the desired location.
const nek_mesh::NekMeshEnum	_pp_mesh
	Which NekRS mesh to act on.
const NekRSProblemBase *	_nek_problem
	The NekRSProblemBase required by all objects which inherit from NekBase.
const NekRSMesh *	_nek_mesh
	Underlying NekRSMesh, if present.
const field::NekFieldEnum	_field
	NekRS solution field.
component::BinnedVelocityComponentEnum	_velocity_component
Point	_velocity_direction
	Direction in which to evaluate velocity, when field = velocity_component.

Detailed Description

Interpolate a NekRS solution field onto a point, using NekRS's pointInterpolation. The provided point does not need to be a grid point; interpolation happens on GPU.

NOTE: NekRS does not provide an interface to capture any errors if a point provided is not actually contained. They only print to the console. Any point specified, but which is outside the mesh, will silently return zero.

Constructor & Destructor Documentation

NekPointValue()

NekPointValue::NekPointValue

(

const InputParameters &

parameters

)

Member Function Documentation

execute()

virtual void NekPointValue::execute ( )

overridevirtual

Reimplemented from NekFieldPostprocessor.

field()

const field::NekFieldEnum & NekFieldInterface::field ( ) const

inlineinherited

Get the field

Returns

field

getValue()

virtual Real NekPointValue::getValue ( ) const

overridevirtual

initialize()

virtual void NekFieldPostprocessor::initialize ( )

inlineoverridevirtualinherited

validParams()

static InputParameters NekPointValue::validParams ( )

static

Member Data Documentation

_field

const field::NekFieldEnum NekFieldInterface::_field

protectedinherited

NekRS solution field.

_nek_mesh

const NekRSMesh* NekBase::_nek_mesh

protectedinherited

Underlying NekRSMesh, if present.

_nek_problem

const NekRSProblemBase* NekBase::_nek_problem

protectedinherited

The NekRSProblemBase required by all objects which inherit from NekBase.

_point

const Point& NekPointValue::_point

protected

Point where the field will be evaluated.

_pp_mesh

const nek_mesh::NekMeshEnum NekFieldPostprocessor::_pp_mesh

protectedinherited

Which NekRS mesh to act on.

_value

Real NekPointValue::_value

protected

The value of the variable at the desired location.

_velocity_component

component::BinnedVelocityComponentEnum NekFieldInterface::_velocity_component

protectedinherited

Direction in which to evaluate velocity, if using 'field = velocity_component'. Options: user (then provide a general vector direction with the 'velocity_direction' parameter normal (normal to an interface, context dependent on daughter class)

_velocity_direction

Point NekFieldInterface::_velocity_direction

protectedinherited

Direction in which to evaluate velocity, when field = velocity_component.

---

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

• include/postprocessors/NekPointValue.h