NSWeakStagnationInletBC

under construction:Undocumented Class

The NSWeakStagnationInletBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.


# NSWeakStagnationInletBC

!syntax description /Modules/NavierStokes/BCs/NSWeakStagnationInletBC

## Overview

!! Replace these lines with information regarding the NSWeakStagnationInletBC object.

## Example Input File Syntax

!! Describe and include an example of how to use the NSWeakStagnationInletBC object.

!syntax parameters /Modules/NavierStokes/BCs/NSWeakStagnationInletBC

!syntax inputs /Modules/NavierStokes/BCs/NSWeakStagnationInletBC

!syntax children /Modules/NavierStokes/BCs/NSWeakStagnationInletBC

This class facilitates adding weak stagnation inlet BCs via an Action by setting up the required parameters.

Input Parameters

  • boundaryThe list of boundary IDs from the mesh where this boundary condition applies

    C++ Type:std::vector

    Options:

    Description:The list of boundary IDs from the mesh where this boundary condition applies

  • fluid_propertiesThe name of the user object for fluid properties

    C++ Type:UserObjectName

    Options:

    Description:The name of the user object for fluid properties

  • stagnation_pressureThe specifed stagnation pressure

    C++ Type:double

    Options:

    Description:The specifed stagnation pressure

  • stagnation_temperatureThe specifed stagnation temperature

    C++ Type:double

    Options:

    Description:The specifed stagnation temperature

  • sxx-component of specifed flow direction

    C++ Type:double

    Options:

    Description:x-component of specifed flow direction

Required Parameters

  • sy0y-component of specifed flow direction

    Default:0

    C++ Type:double

    Options:

    Description:y-component of specifed flow direction

  • sz0z-component of specifed flow direction

    Default:0

    C++ Type:double

    Options:

    Description:z-component of specifed flow direction

Optional Parameters

  • control_tagsAdds user-defined labels for accessing object parameters via control logic.

    C++ Type:std::vector

    Options:

    Description:Adds user-defined labels for accessing object parameters via control logic.

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Options:

    Description:Set the enabled status of the MooseObject.

Advanced Parameters

Input Files