NekVolumeIntegral Class Reference

#include <NekVolumeIntegral.h>

Inheritance diagram for NekVolumeIntegral:

Public Member Functions
	NekVolumeIntegral (const InputParameters &parameters)
virtual Real	getValue () const override
Real	getIntegralOnMesh (const nek_mesh::NekMeshEnum &mesh) const
Real	volume () const
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 NekRSProblem *	_nek_problem
	The NekRSProblem required by all objects which inherit from NekBase.
const NekRSMesh *	_nek_mesh
	Underlying NekRSMesh, if present.
const field::NekFieldEnum	_field
	NekRS solution field.
const Function *	_function
	Function to shift the field by, if provided by the 'function' parameter.
component::BinnedVelocityComponentEnum	_velocity_component
Point	_velocity_direction
	Direction in which to evaluate velocity, when field = velocity_component.

Detailed Description

Compute the integral of a specified quantity over the scalar nekRS mesh, \(\int_\Omega f d\Omega\), where \(f\) is the field to be integrated, and \(\Omega\) is the volume.

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

NekVolumeIntegral()

NekVolumeIntegral::NekVolumeIntegral

(

const InputParameters &

parameters

)

Member Function Documentation

execute()

virtual void NekFieldPostprocessor::execute ( )

inlineoverridevirtualinherited

Reimplemented in NekPointValue.

field()

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

inlineinherited

Get the field

Returns

field

getIntegralOnMesh()

Real NekVolumeIntegral::getIntegralOnMesh

(

const nek_mesh::NekMeshEnum &

mesh

)

const

Integrate the field over the specified mesh

Parameters

[in]

mesh

mesh

Returns

field integrated over the mesh

getValue()

virtual Real NekVolumeIntegral::getValue ( ) const

overridevirtual

Reimplemented in NekVolumeAverage.

initialize()

virtual void NekFieldPostprocessor::initialize ( )

inlineoverridevirtualinherited

validParams()

static InputParameters NekVolumeIntegral::validParams ( )

static

volume()

Real NekVolumeIntegral::volume

(

)

const

Volume by which to normalize

Returns

volume

Member Data Documentation

_field

const field::NekFieldEnum NekFieldInterface::_field

protectedinherited

NekRS solution field.

_function

const Function* NekFieldInterface::_function

protectedinherited

Function to shift the field by, if provided by the 'function' parameter.

_nek_mesh

const NekRSMesh* NekBase::_nek_mesh

protectedinherited

Underlying NekRSMesh, if present.

_nek_problem

const NekRSProblem* NekBase::_nek_problem

protectedinherited

The NekRSProblem required by all objects which inherit from NekBase.

_pp_mesh

const nek_mesh::NekMeshEnum NekFieldPostprocessor::_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/NekVolumeIntegral.h