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
NekFieldInterface Class Reference

#include <NekFieldInterface.h>

Inheritance diagram for NekFieldInterface:
[legend]

Public Member Functions

 NekFieldInterface (const MooseObject *moose_object, const InputParameters &parameters, const bool allow_normal=false)
 
const field::NekFieldEnumfield () const
 

Static Public Member Functions

static InputParameters validParams ()
 

Protected Attributes

const field::NekFieldEnum _field
 NekRS solution field.
 
component::BinnedVelocityComponentEnum _velocity_component
 
Point _velocity_direction
 Direction in which to evaluate velocity, when field = velocity_component.
 

Constructor & Destructor Documentation

◆ NekFieldInterface()

NekFieldInterface::NekFieldInterface ( const MooseObject *  moose_object,
const InputParameters &  parameters,
const bool  allow_normal = false 
)

Member Function Documentation

◆ field()

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

Get the field

Returns
field

◆ validParams()

static InputParameters NekFieldInterface::validParams ( )
static

Member Data Documentation

◆ _field

const field::NekFieldEnum NekFieldInterface::_field
protected

NekRS solution field.

◆ _velocity_component

component::BinnedVelocityComponentEnum NekFieldInterface::_velocity_component
protected

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
protected

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


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