NekSideAverage Class Reference

#include <NekSideAverage.h>

Inheritance diagram for NekSideAverage:

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

Static Public Member Functions
static InputParameters	validParams ()

Protected Attributes
const nek_mesh::NekMeshEnum	_pp_mesh
	Which NekRS mesh to act on.
const std::vector< int > &	_boundary
	boundary IDs of the nekRS mesh over which to find the extreme value
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

Compute the average of a specified quantity over the boundaries in the nekRS mesh, $\frac{\int_\Gamma f d\Gamma}{\int_\Gamma d\Gamma}$, where $f$ is the field to be integrated, and $\Gamma$ is the boundary.

Note that this calculation is done directly on the mesh that nekRS solves on, not the mesh created for solution transfer in NekRSMesh.

Constructor & Destructor Documentation

NekSideAverage()

NekSideAverage::NekSideAverage

(

const InputParameters &

parameters

)

Member Function Documentation

execute()

virtual void NekSidePostprocessor::execute ( )

inlineoverridevirtualinherited

field()

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

inlineinherited

Get the field

Returns

field

getValue()

virtual Real NekSideAverage::getValue ( ) const

overridevirtual

Reimplemented from NekSideIntegral.

initialize()

virtual void NekSidePostprocessor::initialize ( )

inlineoverridevirtualinherited

validParams()

static InputParameters NekSideAverage::validParams ( )

static

Member Data Documentation

_boundary

const std::vector<int>& NekSidePostprocessor::_boundary

protectedinherited

boundary IDs of the nekRS mesh over which to find the extreme value

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

_pp_mesh

const nek_mesh::NekMeshEnum NekSidePostprocessor::_pp_mesh

protectedinherited

Which NekRS mesh to act on.

_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/NekSideAverage.h