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

#include <NekVolumeIntegral.h>

Inheritance diagram for NekVolumeIntegral:
[legend]

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
 

Static Public Member Functions

static InputParameters validParams ()
 

Protected Attributes

const field::NekFieldEnum _field
 integrand of the surface integral More...
 
Point _velocity_direction
 Direction in which to evaluate velocity, when field = velocity_component. More...
 
const MooseMesh & _mesh
 Base mesh this postprocessor acts on. More...
 
const NekRSMesh_nek_mesh
 Underlying NekRSMesh, if present. More...
 
const NekRSProblemBase_nek_problem
 Underlying problem. More...
 
const nek_mesh::NekMeshEnum _pp_mesh
 Which NekRS mesh to act on. More...
 

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 NekPostprocessor::execute ( )
inlineoverridevirtualinherited

Reimplemented in NekMeshInfoPostprocessor.

◆ getIntegralOnMesh()

Real NekVolumeIntegral::getIntegralOnMesh ( const nek_mesh::NekMeshEnum mesh) const

Integrate the field over the specified mesh

Parameters
[in]meshmesh
Returns
field integrated over the mesh

◆ getValue()

virtual Real NekVolumeIntegral::getValue ( ) const
overridevirtual

Reimplemented in NekVolumeAverage.

◆ initialize()

virtual void NekPostprocessor::initialize ( )
inlineoverridevirtualinherited

Reimplemented in NekMeshInfoPostprocessor.

◆ 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 NekFieldPostprocessor::_field
protectedinherited

integrand of the surface integral

◆ _mesh

const MooseMesh& NekPostprocessor::_mesh
protectedinherited

Base mesh this postprocessor acts on.

◆ _nek_mesh

const NekRSMesh* NekPostprocessor::_nek_mesh
protectedinherited

Underlying NekRSMesh, if present.

◆ _nek_problem

const NekRSProblemBase* NekPostprocessor::_nek_problem
protectedinherited

Underlying problem.

◆ _pp_mesh

const nek_mesh::NekMeshEnum NekPostprocessor::_pp_mesh
protectedinherited

Which NekRS mesh to act on.

◆ _velocity_direction

Point NekFieldPostprocessor::_velocity_direction
protectedinherited

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


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