FVMatAdvectionOutflowBC

Description

FVMatAdvectionOutflowBC adds an identical type of residual as FVMatAdvection but as it is imposed on a boundary it's only added to one side of a face. As the name implies this BC should be imposed at an outflow boundary as it simply advects either a material property optionally specified with the advected_quantity parameter or the variable upon which the BC is applied out of the domain with a velocity specified through the vel parameter.

Input Parameters

boundaryThe list of boundary IDs from the mesh where this boundary condition applies
C++ Type:std::vector<BoundaryName>
Options:
Description:The list of boundary IDs from the mesh where this boundary condition applies
variableThe name of the variable that this boundary condition applies to
C++ Type:NonlinearVariableName
Options:
Description:The name of the variable that this boundary condition applies to
veladvection velocity
C++ Type:MaterialPropertyName
Options:
Description: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'.
advected_quantityAn optional parameter for specifying an advected quantity from a material property. If this is not specified, then the advected quantity will simply be the variable that this object is acting on
C++ Type:MaterialPropertyName
Options:
Description:An optional parameter for specifying an advected quantity from a material property. If this is not specified, then the advected quantity will simply be the variable that this object is acting on
displacementsThe displacements
C++ Type:std::vector<VariableName>
Options:
Description:The displacements
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
Options:
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.

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

(test/tests/fvkernels/fv_euler/fv_euler.i)

Child Objects

(modules/navier_stokes/include/fvbcs/PINSFVMomentumAdvectionOutflowBC.h)
(modules/navier_stokes/include/fvbcs/INSFVMomentumAdvectionOutflowBC.h)

(test/tests/fvkernels/fv_euler/fv_euler.i)

[Mesh]
  [gen]
    type = GeneratedMeshGenerator
    dim = 1
    nx = 20
  []
[]

[Variables]
  # we have to impose non-zero initial conditions in order to avoid an initially
  # singular matrix
  [fv_vel]
    order = CONSTANT
    family = MONOMIAL
    fv = true
    initial_condition = 2
  []
  [fv_rho]
    order = CONSTANT
    family = MONOMIAL
    fv = true
    initial_condition = 2
  []
[]

[FVKernels]
  # del * rho * velocity * velocity
  [adv_rho_u]
    type = FVMatAdvection
    variable = fv_vel
    vel = 'fv_velocity'
    advected_quantity = 'rho_u'
  []

  # del * rho * velocity
  [adv_rho]
    type = FVMatAdvection
    variable = fv_rho
    vel = 'fv_velocity'
  []
[]


[FVBCs]
  [left_vel]
    type = FVDirichletBC
    variable = fv_vel
    value = 1
    boundary = 'left'
  []
  [left_rho]
    type = FVDirichletBC
    variable = fv_rho
    value = 1
    boundary = 'left'
  []

  # del * rho * velocity * velocity
  [right_vel]
    type = FVMatAdvectionOutflowBC
    variable = fv_vel
    vel = 'fv_velocity'
    advected_quantity = 'rho_u'
    boundary = 'right'
  []

  # del * rho * velocity
  [adv_rho]
    type = FVMatAdvectionOutflowBC
    variable = fv_rho
    vel = 'fv_velocity'
    boundary = 'right'
  []
[]

[Materials]
  [euler_material]
    type = ADCoupledVelocityMaterial
    vel_x = fv_vel
    rho = fv_rho
    velocity = 'fv_velocity'
  []
[]

[Executioner]
  type = Steady
  solve_type = NEWTON
  line_search = 'none'
[]

[Outputs]
  [out]
    type = Exodus
    execute_on = 'final'
  []
[]

(modules/navier_stokes/include/fvbcs/PINSFVMomentumAdvectionOutflowBC.h)

// This file is part of the MOOSE framework
// https://www.mooseframework.org
//
// All rights reserved, see COPYRIGHT for full restrictions
// https://github.com/idaholab/moose/blob/master/COPYRIGHT
//
// Licensed under LGPL 2.1, please see LICENSE for details
// https://www.gnu.org/licenses/lgpl-2.1.html

#pragma once

#include "FVMatAdvectionOutflowBC.h"
#include "INSFVFullyDevelopedFlowBC.h"

class INSFVVelocityVariable;

/**
 * A class for finite volume fully developed outflow boundary conditions for the momentum equation
 * It advects superficial momentum at the outflow, and may replace outlet pressure boundary
 * conditions when selecting a mean-pressure approach.
 */
class PINSFVMomentumAdvectionOutflowBC : public FVMatAdvectionOutflowBC,
                                         public INSFVFullyDevelopedFlowBC
{
public:
  static InputParameters validParams();
  PINSFVMomentumAdvectionOutflowBC(const InputParameters & params);

protected:
  virtual ADReal computeQpResidual() override;

  /// x-velocity
  const INSFVVelocityVariable * const _u_var;
  /// y-velocity
  const INSFVVelocityVariable * const _v_var;
  /// z-velocity
  const INSFVVelocityVariable * const _w_var;
  /// porosity
  const VariableValue & _eps;
  /// porosity in the neighbor cell (for continuous porosities) FIXME: eps should not be defined on the other side of the boundary
  const VariableValue & _eps_neighbor;
  /// the dimension of the simulation
  const unsigned int _dim;
};

(modules/navier_stokes/include/fvbcs/INSFVMomentumAdvectionOutflowBC.h)

// This file is part of the MOOSE framework
// https://www.mooseframework.org
//
// All rights reserved, see COPYRIGHT for full restrictions
// https://github.com/idaholab/moose/blob/master/COPYRIGHT
//
// Licensed under LGPL 2.1, please see LICENSE for details
// https://www.gnu.org/licenses/lgpl-2.1.html

#pragma once

#include "FVMatAdvectionOutflowBC.h"
#include "INSFVFullyDevelopedFlowBC.h"

class INSFVVelocityVariable;

/**
 * A class for finite volume fully developed outflow boundary conditions for the momentum equation
 * It advects momentum at the outflow, and may replace outlet pressure boundary conditions
 * when selecting a mean-pressure approach.
 */
class INSFVMomentumAdvectionOutflowBC : public FVMatAdvectionOutflowBC,
                                        public INSFVFullyDevelopedFlowBC
{
public:
  static InputParameters validParams();
  INSFVMomentumAdvectionOutflowBC(const InputParameters & params);

protected:
  virtual ADReal computeQpResidual() override;

  /// x-velocity
  const INSFVVelocityVariable * const _u_var;
  /// y-velocity
  const INSFVVelocityVariable * const _v_var;
  /// z-velocity
  const INSFVVelocityVariable * const _w_var;

  /// the dimension of the simulation
  const unsigned int _dim;
};

Description
Input Parameters
Input Files
Child Objects

Install MOOSE

New Users

Examples and Tutorials

Application Usage

Physics and Syntax

Application Development

Framework Development

MOOSEDocs

Infrastructure

Questions

Information and Tools

INL Applications and Remote Access