Loading [MathJax]/extensions/tex2jax.js
Cardinal
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
NekFieldPostprocessor Class Reference

#include <NekFieldPostprocessor.h>

Inheritance diagram for NekFieldPostprocessor:
[legend]

Public Member Functions

 NekFieldPostprocessor (const InputParameters &parameters)
 
virtual void initialize () override
 
virtual void execute () override
 
const field::NekFieldEnumfield () const
 

Static Public Member Functions

static InputParameters validParams ()
 

Protected Attributes

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

Base class for NekRS postprocessors that operate on fields, such as for taking averages of a field variable.

Constructor & Destructor Documentation

◆ NekFieldPostprocessor()

NekFieldPostprocessor::NekFieldPostprocessor ( const InputParameters &  parameters)

Member Function Documentation

◆ execute()

virtual void NekFieldPostprocessor::execute ( )
inlineoverridevirtual

Reimplemented in NekPointValue.

◆ field()

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

Get the field

Returns
field

◆ initialize()

virtual void NekFieldPostprocessor::initialize ( )
inlineoverridevirtual

◆ validParams()

static InputParameters NekFieldPostprocessor::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.

◆ _pp_mesh

const nek_mesh::NekMeshEnum NekFieldPostprocessor::_pp_mesh
protected

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: