Cardinal
Public Member Functions | Static Public Member Functions | List of all members
PecletNumber Class Reference

#include <PecletNumber.h>

Inheritance diagram for PecletNumber:
[legend]

Public Member Functions

 PecletNumber (const InputParameters &parameters)
 
virtual Real getValue () const override
 

Static Public Member Functions

static InputParameters validParams ()
 

Detailed Description

Compute the Peclet number as \(Re\ Pr\), where $Re$ is the Reynolds number and \(Pr\) is the Prandtl number. The 'boundary' is used to specify which boundary of NekRS's mesh to use for computing the mass flowrate and area.

If NekRS is run in dimensional form, then the characteristic length must be provided manually - otherwise, it is inferred from the Reynolds number given in the input file.

Constructor & Destructor Documentation

◆ PecletNumber()

PecletNumber::PecletNumber ( const InputParameters &  parameters)

Member Function Documentation

◆ getValue()

virtual Real PecletNumber::getValue ( ) const
overridevirtual

◆ validParams()

static InputParameters PecletNumber::validParams ( )
static

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