FVAdvection

buildconstruction:Undocumented Class

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


# FVAdvection

!syntax description /FVKernels/FVAdvection

## Overview

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

## Example Input File Syntax

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

!syntax parameters /FVKernels/FVAdvection

!syntax inputs /FVKernels/FVAdvection

!syntax children /FVKernels/FVAdvection

Residual contribution from advection operator for finite volume method.

Input Parameters

  • variableThe name of the finite volume variable this kernel applies to

    C++ Type:NonlinearVariableName

    Options:

    Description:The name of the finite volume variable this kernel applies to

  • velocityConstant advection velocity

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

    Options:

    Description:Constant advection velocity

Required Parameters

  • advected_interp_methodupwindThe interpolation to use for the advected quantity. Options are 'upwind' and 'average', with the default being 'upwind'.

    Default:upwind

    C++ Type:MooseEnum

    Options:average, upwind

    Description:The interpolation to use for the advected quantity. Options are 'upwind' and 'average', with the default being 'upwind'.

  • blockThe list of block ids (SubdomainID) that this object will be applied

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

    Options:

    Description:The list of block ids (SubdomainID) that this object will be applied

  • boundaries_to_forceThe set of boundaries to force execution of this FVFluxKernel on.

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

    Options:

    Description:The set of boundaries to force execution of this FVFluxKernel on.

  • boundaries_to_not_forceThe set of boundaries to not force execution of this FVFluxKernel on.

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

    Options:

    Description:The set of boundaries to not force execution of this FVFluxKernel on.

  • force_boundary_executionFalseWhether to force execution of this object on the boundary.

    Default:False

    C++ Type:bool

    Options:

    Description:Whether to force execution of this object on the boundary.

  • ghost_layers1The number of layers of elements to ghost.

    Default:1

    C++ Type:unsigned short

    Options:

    Description:The number of layers of elements to ghost.

  • use_point_neighborsFalseWhether to use point neighbors, which introduces additional ghosting to that used for simple face neighbors.

    Default:False

    C++ Type:bool

    Options:

    Description:Whether to use point neighbors, which introduces additional ghosting to that used for simple face neighbors.

Optional Parameters

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

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

    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.

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

    Default:True

    C++ Type:bool

    Options:

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

  • 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

    Options:

    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

  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

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

    Options:

    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>

    Options:

    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

    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

    Description:The tag for the vectors this Kernel should fill

Tagging Parameters

Input Files