BVFVSinglePhaseSoluteDarcy

construction:Undocumented Class

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

Kernel for the divergence of Darcy's velocity for single pahse flow and solute transport.

Overview

Example Input File Syntax

Input Parameters

fluid_pressureThe fluid pressure variable.
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:The fluid pressure variable.
variableThe name of the variable that this residual object operates on
C++ Type:NonlinearVariableName
Unit:(no unit assumed)
Controllable:No
Description:The name of the variable that this residual object operates on

Required Parameters

blockThe list of blocks (ids or names) that this object will be applied
C++ Type:std::vector<SubdomainName>
Unit:(no unit assumed)
Controllable:No
Description:The list of blocks (ids or names) that this object will be applied
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
Unit:(no unit assumed)
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.
use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

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>
Unit:(no unit assumed)
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>
Unit:(no unit assumed)
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>
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
Options:nontime, time
Controllable:No
Description:The tag for the vectors this Kernel should fill

Tagging Parameters

boundaries_to_avoidThe set of sidesets to not execute this FVFluxKernel on. This takes precedence over force_boundary_execution to restrict to less external boundaries. By default flux kernels are executed on all internal boundaries and Dirichlet boundary conditions.
C++ Type:std::vector<BoundaryName>
Unit:(no unit assumed)
Controllable:No
Description:The set of sidesets to not execute this FVFluxKernel on. This takes precedence over force_boundary_execution to restrict to less external boundaries. By default flux kernels are executed on all internal boundaries and Dirichlet boundary conditions.
boundaries_to_forceThe set of sidesets to force execution of this FVFluxKernel on. Setting force_boundary_execution to true is equivalent to listing all external mesh boundaries in this parameter.
C++ Type:std::vector<BoundaryName>
Unit:(no unit assumed)
Controllable:No
Description:The set of sidesets to force execution of this FVFluxKernel on. Setting force_boundary_execution to true is equivalent to listing all external mesh boundaries in this parameter.
force_boundary_executionFalseWhether to force execution of this object on all external boundaries.
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Whether to force execution of this object on all external boundaries.

Boundary Execution Modification Parameters

control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Unit:(no unit assumed)
Controllable:No
Description:Adds user-defined labels for accessing object parameters via control logic.
enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Unit:(no unit assumed)
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
Unit:(no unit assumed)
Controllable:No
Description:Determines whether this object is calculated using an implicit or explicit form
seed0The seed for the master random number generator
Default:0
C++ Type:unsigned int
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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

ghost_layers2The number of layers of elements to ghost.
Default:2
C++ Type:unsigned short
Unit:(no unit assumed)
Controllable:No
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
Unit:(no unit assumed)
Controllable:No
Description:Whether to use point neighbors, which introduces additional ghosting to that used for simple face neighbors.

Parallel Ghosting Parameters

Input Files

(examples/solute/advection-diffusion/advection-diffusion.i)

(examples/solute/advection-diffusion/advection-diffusion.i)

[Mesh]
  type = GeneratedMesh
  dim = 1
  nx = 400
  xmin = 0
  xmax = 1
[]

[Variables]
  [pf]
    order = CONSTANT
    family = MONOMIAL
    fv = true
  []
  [c]
    order = CONSTANT
    family = MONOMIAL
    fv = true
  []
[]

[ICs]
  [pf_ic]
    type = FunctionIC
    variable = pf
    function = '1-x'
  []
[]

[FVKernels]
  # [time_derivative_p]
  #   type = BVFVSinglePhaseTimeDerivative
  #   variable = pf
  # []
  [darcy_p]
    type = BVFVSinglePhaseDarcy
    variable = pf
  []
  [time_derivative_c]
    type = BVFVSinglePhaseSoluteTimeDerivative
    variable = c
  []
  [darcy_c]
    type = BVFVSinglePhaseSoluteDarcy
    variable = c
    fluid_pressure = pf
  []
[]

[AuxVariables]
  [u]
    order = CONSTANT
    family = MONOMIAL
  []
[]

[AuxKernels]
  [u_aux]
    type = BVDarcyVelocityAux
    variable = u
    fluid_pressure = pf
    component = x
    execute_on = 'TIMESTEP_END'
  []
[]

[FVBCs]
  [p_left]
    type = FVDirichletBC
    variable = pf
    boundary = 'left'
    value = 1
  []
  [p_right]
    type = FVDirichletBC
    variable = pf
    boundary = 'right'
    value = 0
  []
  [c_left]
    type = FVDirichletBC
    variable = c
    boundary = 'left'
    value = 1
  []
  [c_right]
    type = FVDirichletBC
    variable = c
    boundary = 'right'
    value = 0
  []
[]

[Materials]
  [fluid_flow_mat]
    type = BVSinglePhaseFlowMaterial
  []
  [permeability]
    type = BVConstantPermeability
    permeability = 1.0
  []
  [porosity]
    type = BVConstantPorosity
    porosity = 1.0
  []
  [solute_mat]
    type = BVSinglePhaseFlowSoluteMaterial
  []
  [dispersion]
    type = BVConstantDispersion
    dispersion = 1.0e-03
  []
  [fluid_properties]
    type = BVFluidProperties
    fluid_pressure = pf
    temperature = 273
    fp = simple_fluid
  []
[]

[FluidProperties]
  [simple_fluid]
    type = SimpleFluidProperties
    density0 = 1.0
    viscosity = 1.0
  []
[]

[VectorPostprocessors]
  [line_c]
    type= LineValueSampler
    num_points = 400
    start_point = '0 0 0'
    end_point = '1 0 0'
    sort_by = x
    variable = c
    execute_on = 'TIMESTEP_END'
    outputs = csv
  []
[]

[Preconditioning]
  [hypre]
    type = SMP
    full = true
    petsc_options = '-snes_ksp_ew'
    petsc_options_iname = '-snes_linesearch_type -pc_type -pc_hypre_type'
    petsc_options_value = 'bt hypre boomeramg'
  []
[]

[Executioner]
  type = Transient
  solve_type = 'NEWTON'
  # scheme = 'BDF2'
  automatic_scaling = true
  residual_and_jacobian_together = true
  start_time = 0
  end_time = 0.6
  num_steps = 600
[]

[Outputs]
  print_linear_residuals = false
  perf_graph = true
  file_base = 'outputs/advection-diffusion'
  exodus = true
  [csv]
    type = CSV
    sync_only = true
    sync_times = '0.2 0.4 0.6'
  []
[]

Overview
Example Input File Syntax
Input Parameters
Input Files