ADConservativeAdvectionBC

Description

The ADConservativeAdvectionBC boundary condition pairs with the ADConservativeAdvection kernel. It can be used for both Dirichlet and "implicit" boundary conditions which use only information from the equation systems solution vectors. Velocity must be provided, either through the velocity_mat_prop parameter (implicit information) or through the velocity_function parameter (Dirichlet information). Similarly, for Dirichlet conditions, a primal_dirichlet_value should be supplied. Otherwise the advected quantity will be determined from implicit information either through the supplied advected_quantity or if that is not supplied, the variable solution. If primal_dirichlet_value is supplied, then a primal_coefficient material property name may be supplied which will multiply the primal_dirichlet_value.

An example of this boundary condition's use is shown in the listing below for both an inlet and outlet condition. At the inlet (boundary = left) both the velocity and primal value (the variable u in this case) are prescribed. At the outlet (boundary= right) due to the absence of primal_dirichlet_value, the current solution value of u is used. Additionally, the velocity is also determined implicitly through velocity_mat_prop.

[BCs]
  [u_walls]
    type = DGFunctionDiffusionDirichletBC
    boundary = 'bottom top'
    variable = u
    sigma = 6
    epsilon = -1
    function = '0'
    diff = 1
  []
  [u_in]
    type = ADConservativeAdvectionBC
    boundary = 'left'
    variable = u
    velocity_function = v_inlet
    primal_dirichlet_value = 1
  []
  [u_out]
    type = ADConservativeAdvectionBC
    boundary = 'right'
    variable = u
    velocity_mat_prop = 'velocity'
  []
[]
(../moose/test/tests/dgkernels/passive-scalar-channel-flow/test.i)

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

  • 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

  • advected_quantityAn optional material property to be advected. If not supplied, then the variable will be used.

    C++ Type:MaterialPropertyName

    Controllable:No

    Description:An optional material property to be advected. If not supplied, then the variable will be used.

  • displacementsThe displacements

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

    Controllable:No

    Description:The displacements

  • primal_coefficient1If a primal Dirichlet value is supplied, then a coefficient may be optionally multiplied that multiples the Dirichlet value

    Default:1

    C++ Type:MaterialPropertyName

    Controllable:No

    Description:If a primal Dirichlet value is supplied, then a coefficient may be optionally multiplied that multiples the Dirichlet value

  • primal_dirichlet_valueThe value of the primal variable on the boundary.

    C++ Type:FunctionName

    Controllable:No

    Description:The value of the primal variable on the boundary.

  • 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.

  • velocity_functionFunction describing the values of velocity on the boundary.

    C++ Type:FunctionName

    Controllable:No

    Description:Function describing the values of velocity on the boundary.

  • velocity_mat_propVelocity vector as a material property. Should be provided when we want the velocity value to be determined implicitly (e.g. we don't have a Dirichlet condition)

    C++ Type:MaterialPropertyName

    Controllable:No

    Description:Velocity vector as a material property. Should be provided when we want the velocity value to be determined implicitly (e.g. we don't have a Dirichlet condition)

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