INSFEFluidMomentumBC

buildconstruction:Undocumented Class

The INSFEFluidMomentumBC 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.

Specifies flow of momentum through a boundary

Overview

Example Input File Syntax

Input Parameters

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

    C++ Type:std::vector<BoundaryName>

    Controllable:No

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

  • component0,1,or 2 for x-, y-, or z- direction

    C++ Type:unsigned int

    Controllable:No

    Description:0,1,or 2 for x-, y-, or z- direction

  • eosThe name of equation of state object to use.

    C++ Type:UserObjectName

    Controllable:No

    Description:The name of equation of state object to use.

  • pressurepressure

    C++ Type:std::vector<VariableName>

    Controllable:No

    Description:pressure

  • temperaturetemperature

    C++ Type:std::vector<VariableName>

    Controllable:No

    Description:temperature

  • uvelocity in x-coord

    C++ Type:std::vector<VariableName>

    Controllable:No

    Description:velocity in x-coord

  • variableThe name of the variable that this residual object operates on

    C++ Type:NonlinearVariableName

    Controllable:No

    Description:The name of the variable that this residual object operates on

Required Parameters

  • branch_centerPosition of branch center in 2D/3D flow mesh system

    C++ Type:libMesh::Point

    Controllable:No

    Description:Position of branch center in 2D/3D flow mesh system

  • conservative_formFalseWhether the conservative form is used

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Whether the conservative form is used

  • displacementsThe displacements

    C++ Type:std::vector<VariableName>

    Controllable:No

    Description:The displacements

  • gravityGravity vector in 2D/3D flow mesh system

    C++ Type:libMesh::VectorValue<double>

    Controllable:No

    Description:Gravity vector in 2D/3D flow mesh system

  • p_branchCoupled scalar branch pressure

    C++ Type:std::vector<VariableName>

    Controllable:No

    Description:Coupled scalar branch pressure

  • p_fnPressure function with time at the boundary

    C++ Type:FunctionName

    Controllable:No

    Description:Pressure function with time at the boundary

  • p_int_by_partsFalseWhether integration by parts is applied to the pressure term

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Whether integration by parts is applied to the pressure term

  • porosityporosity

    C++ Type:std::vector<VariableName>

    Controllable:No

    Description:porosity

  • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

    C++ Type:MaterialPropertyName

    Controllable:No

    Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

  • rho_branchCoupled scalar branch density for gravity head calculation

    C++ Type:std::vector<VariableName>

    Controllable:No

    Description:Coupled scalar branch density for gravity head calculation

  • vvelocity in y-coord

    C++ Type:std::vector<VariableName>

    Controllable:No

    Description:velocity in y-coord

  • v_fnVelocity function with time at the boundary

    C++ Type:FunctionName

    Controllable:No

    Description:Velocity function with time at the boundary

  • wvelocity in z-coord

    C++ Type:std::vector<VariableName>

    Controllable:No

    Description:velocity in z-coord

Optional Parameters

  • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

    C++ Type:std::vector<TagName>

    Controllable:No

    Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

    C++ Type:std::vector<TagName>

    Controllable:No

    Description:The extra tags for the matrices this Kernel should fill

  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

    C++ Type:std::vector<TagName>

    Controllable:No

    Description:The extra tags for the vectors this Kernel should fill

  • matrix_tagssystemThe tag for the matrices this Kernel should fill

    Default:system

    C++ Type:MultiMooseEnum

    Options:nontime, system

    Controllable:No

    Description:The tag for the matrices this Kernel should fill

  • vector_tagsnontimeThe tag for the vectors this Kernel should fill

    Default:nontime

    C++ Type:MultiMooseEnum

    Options:nontime, time

    Controllable:No

    Description:The tag for the vectors this Kernel should fill

Tagging Parameters

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

    C++ Type:std::vector<std::string>

    Controllable:No

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

  • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

    C++ Type:std::vector<AuxVariableName>

    Controllable:No

    Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Controllable:Yes

    Description:Set the enabled status of the MooseObject.

  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

    Default:True

    C++ Type:bool

    Controllable:No

    Description:Determines whether this object is calculated using an implicit or explicit form

  • save_inThe name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

    C++ Type:std::vector<AuxVariableName>

    Controllable:No

    Description:The name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

  • seed0The seed for the master random number generator

    Default:0

    C++ Type:unsigned int

    Controllable:No

    Description:The seed for the master random number generator

  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

Advanced Parameters