NekVolumeNorm Class Reference

#include <NekVolumeNorm.h>

Inheritance diagram for NekVolumeNorm:

Public Member Functions
	NekVolumeNorm (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
Real	_N
	Order of the norm.
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 L$^N$ norm of a NekRS solution field, integrated over the NekRS volume mesh.

Finite values of N compute

(integral |u - f|^N dV)^(1/N).

Setting N = infinity computes

max |u - f|

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

NekVolumeNorm()

NekVolumeNorm::NekVolumeNorm

(

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

getValue()

virtual Real NekVolumeNorm::getValue ( ) const

overridevirtual

initialize()

virtual void NekFieldPostprocessor::initialize ( )

inlineoverridevirtualinherited

validParams()

static InputParameters NekVolumeNorm::validParams ( )

static

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.

_N

Real NekVolumeNorm::_N

protected

Order of the norm.

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