This class allows us to have a section of the input file like the following which automatically adds variables, kernels, aux kernels, bcs for setting up the Navier-Stokes equation. More...

#include <CNSAction.h>

Inheritance diagram for CNSAction:

[legend]

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	CNSAction (const InputParameters &parameters)

virtual void	act () override

void	timedAct ()

virtual void	addRelationshipManagers (Moose::RelationshipManagerType when_type)

MooseObjectName	uniqueActionName () const

const std::string &	specificTaskName () const

const std::set< std::string > &	getAllTasks () const

void	appendTask (const std::string &task)

MooseApp &	getMooseApp () const

const std::string &	type () const

const std::string &	name () const

std::string	typeAndName () const

MooseObjectParameterName	uniqueParameterName (const std::string &parameter_name) const

MooseObjectName	uniqueName () const

const InputParameters &	parameters () const

const hit::Node *	getHitNode () const

bool	hasBase () const

const std::string &	getBase () const

const T &	getParam (const std::string &name) const

std::vector< std::pair< T1, T2 > >	getParam (const std::string &param1, const std::string &param2) const

const T *	queryParam (const std::string &name) const

const T &	getRenamedParam (const std::string &old_name, const std::string &new_name) const

T	getCheckedPointerParam (const std::string &name, const std::string &error_string="") const

bool	isParamValid (const std::string &name) const

bool	isParamSetByUser (const std::string &name) const

void	connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const

void	paramError (const std::string &param, Args... args) const

void	paramWarning (const std::string &param, Args... args) const

void	paramWarning (const std::string &param, Args... args) const

void	paramInfo (const std::string &param, Args... args) const

std::string	messagePrefix (const bool hit_prefix=true) const

std::string	errorPrefix (const std::string &) const

void	mooseError (Args &&... args) const

void	mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const

void	mooseErrorNonPrefixed (Args &&... args) const

void	mooseWarning (Args &&... args) const

void	mooseWarning (Args &&... args) const

void	mooseWarningNonPrefixed (Args &&... args) const

void	mooseWarningNonPrefixed (Args &&... args) const

void	mooseDeprecated (Args &&... args) const

void	mooseDeprecated (Args &&... args) const

void	mooseDeprecatedNoTrace (Args &&... args) const

void	mooseInfo (Args &&... args) const

void	callMooseError (std::string msg, const bool with_prefix, const hit::Node *node=nullptr, const bool show_trace=true) const

std::string	getDataFileName (const std::string &param) const

std::string	getDataFileNameByName (const std::string &relative_path) const

std::string	getDataFilePath (const std::string &relative_path) const

PerfGraph &	perfGraph ()

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

Static Public Member Functions
static InputParameters	validParams ()

static void	callMooseError (MooseApp const app, const InputParameters &params, std::string msg, const bool with_prefix, const hit::Node node, const bool show_trace=true)

Public Attributes
	usingCombinedWarningSolutionWarnings

const ConsoleStream	_console

Static Public Attributes
static const std::string	unique_action_name_param

static const std::string	type_param

static const std::string	name_param

static const std::string	unique_name_param

static const std::string	app_param

static const std::string	moose_base_param

static const std::string	kokkos_object_param

static constexpr auto	SYSTEM

static constexpr auto	NAME

Protected Member Functions
void	setKernelCommonParams (InputParameters &params)

void	setBCCommonParams (InputParameters &params)

void	setStagnationBCCommonParams (InputParameters &params, unsigned int i)

void	coupleVelocities (InputParameters &params)

void	coupleMomentums (InputParameters &params)

void	addNSTimeKernels ()

void	addNSMassInviscidFlux ()

void	addNSMomentumInviscidFlux (unsigned int component)

void	addNSEnergyInviscidFlux ()

void	addNSSUPGMass ()

void	addNSSUPGMomentum (unsigned int component)

void	addNSSUPGEnergy ()

void	addPressureOrTemperatureAux (const std::string &kernel_type)

void	addNSVelocityAux (unsigned int component)

void	addSpecificTotalEnthalpyAux ()

void	addNSMachAux ()

void	addNSInternalEnergyAux ()

void	addSpecificVolumeComputation ()

void	addNSMassWeakStagnationBC ()

void	addNSEnergyWeakStagnationBC ()

void	addNSMomentumWeakStagnationBC (unsigned int component)

void	addNoPenetrationBC (unsigned int component)

void	addNSMassUnspecifiedNormalFlowBC ()

void	addNSEnergyInviscidSpecifiedPressureBC ()

void	addNSMomentumInviscidSpecifiedPressureBC (unsigned int component)

bool	addRelationshipManagers (Moose::RelationshipManagerType when_type, const InputParameters &moose_object_pars)

void	associateWithParameter (const std::string &param_name, InputParameters &params) const

void	associateWithParameter (const InputParameters &from_params, const std::string &param_name, InputParameters &params) const

const T &	getMeshProperty (const std::string &data_name, const std::string &prefix)

const T &	getMeshProperty (const std::string &data_name)

bool	hasMeshProperty (const std::string &data_name, const std::string &prefix) const

bool	hasMeshProperty (const std::string &data_name, const std::string &prefix) const

bool	hasMeshProperty (const std::string &data_name) const

bool	hasMeshProperty (const std::string &data_name) const

std::string	meshPropertyName (const std::string &data_name) const

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level) const

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const

std::string	timedSectionName (const std::string &section_name) const

void	flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const

InvalidSolutionID	registerInvalidSolutionInternal (const std::string &message, const bool warning) const

Static Protected Member Functions
static std::string	meshPropertyName (const std::string &data_name, const std::string &prefix)

Protected Attributes
MooseEnum	_type
	Equation type, transient or steady-state.

UserObjectName	_fp_name
	Name of the FluidProperties object to pass on to Kernels.

std::vector< SubdomainName >	_blocks
	Subdomains Navier-Stokes equation is defined on.

std::vector< BoundaryName >	_stagnation_boundary
	Boundaries stagnation BC applies.

std::vector< Real >	_stagnation_pressure
	Pressures on stagnation boundaries.

std::vector< Real >	_stagnation_temperature
	Temperatures on stagnation boundaries.

std::vector< Real >	_stagnation_direction
	Flow directions on stagnation boundaries.

std::vector< BoundaryName >	_no_penetration_boundary
	Boundaries no-penetration BC applies.

std::vector< BoundaryName >	_static_pressure_boundary
	Boundaries static pressure BC applies.

std::vector< Real >	_static_pressure
	Pressures on static pressure boundaries.

libMesh::FEType	_fe_type
	FE type for various variables.

Real	_initial_pressure
	Initial value for pressure.

Real	_initial_temperature
	Initial value for temperature.

RealVectorValue	_initial_velocity
	Initial value for velocity.

unsigned int	_dim
	Mesh dimension.

std::set< SubdomainID >	_block_ids
	Subdomain IDs.

const std::string	_pressure_variable_name
	pressure variable name

std::string	_registered_identifier

std::string	_specific_task_name

std::set< std::string >	_all_tasks

ActionWarehouse &	_awh

const std::string &	_current_task

std::shared_ptr< MooseMesh > &	_mesh

std::shared_ptr< MooseMesh > &	_displaced_mesh

std::shared_ptr< FEProblemBase > &	_problem

PerfID	_act_timer

MooseApp &	_app

Factory &	_factory

ActionFactory &	_action_factory

const std::string &	_name

const InputParameters &	_pars

MooseApp &	_pg_moose_app

const std::string	_prefix

const Parallel::Communicator &	_communicator

Private Member Functions
bool	addRelationshipManager (Moose::RelationshipManagerType input_rm_type, const InputParameters &moose_object_pars, std::string rm_name, Moose::RelationshipManagerType rm_type, Moose::RelationshipManagerInputParameterCallback rm_input_parameter_func, Moose::RMSystemType sys_type=Moose::RMSystemType::NONE)

virtual std::string	meshPropertyPrefix (const std::string &data_name) const

const RestartableDataValue &	getMeshPropertyInternal (const std::string &data_name, const std::string &prefix) const

void	mooseErrorInternal (Args &&... args) const

Static Private Member Functions
static const hit::Node *	getHitNode (const InputParameters &params)

static std::string	messagePrefix (const InputParameters &params, const bool hit_prefix)

Private Attributes
const ParallelParamObject &	_parent

MooseApp &	_meta_data_app

const MooseObject *const	_meta_data_object

const MooseBase &	_si_moose_base

const FEProblemBase *	_si_problem

Detailed Description

This class allows us to have a section of the input file like the following which automatically adds variables, kernels, aux kernels, bcs for setting up the Navier-Stokes equation.

[Modules] [CompressibleNavierStokes] [] []

Definition at line 28 of file CNSAction.h.

Constructor & Destructor Documentation

◆ CNSAction()

CNSAction::CNSAction ( const InputParameters & parameters )

Definition at line 97 of file CNSAction.C.

  : Action(parameters),
    _type(getParam<MooseEnum>("equation_type")),
    _fp_name(getParam<UserObjectName>("fluid_properties")),
    _blocks(getParam<std::vector<SubdomainName>>("block")),
    _stagnation_boundary(getParam<std::vector<BoundaryName>>("stagnation_boundary")),
    _stagnation_pressure(getParam<std::vector<Real>>("stagnation_pressure")),
    _stagnation_temperature(getParam<std::vector<Real>>("stagnation_temperature")),
    _stagnation_direction(getParam<std::vector<Real>>("stagnation_flow_direction")),
    _no_penetration_boundary(getParam<std::vector<BoundaryName>>("no_penetration_boundary")),
    _static_pressure_boundary(getParam<std::vector<BoundaryName>>("static_pressure_boundary")),
    _static_pressure(getParam<std::vector<Real>>("static_pressure")),
    _fe_type(Utility::string_to_enum<Order>(getParam<MooseEnum>("order")),
             Utility::string_to_enum<FEFamily>(getParam<MooseEnum>("family"))),
    _initial_pressure(getParam<Real>("initial_pressure")),
    _initial_temperature(getParam<Real>("initial_temperature")),
    _initial_velocity(getParam<RealVectorValue>("initial_velocity")),
    _pressure_variable_name(isParamValid("pressure_variable_name")
                                ? getParam<std::string>("pressure_variable_name")
                                : "p")
{
  if (_stagnation_pressure.size() != _stagnation_boundary.size())
    paramError("stagnation_pressure",
               "Size is not the same as the number of boundaries in 'stagnation_boundary'");
  if (_stagnation_temperature.size() != _stagnation_boundary.size())
    paramError("stagnation_temperature",
               "Size is not the same as the number of boundaries in 'stagnation_boundary'");
  if (_static_pressure.size() != _static_pressure_boundary.size())
    paramError("static_pressure",
               "Size is not the same as the number of boundaries in 'static_pressure_boundary'");
}

Member Function Documentation

◆ act()

void CNSAction::act ( )

overridevirtual

Implements Action.

Definition at line 130 of file CNSAction.C.

{
  if (_current_task == "add_navier_stokes_variables")
  {
    _dim = _mesh->dimension();
    for (const auto & subdomain_name : _blocks)
    {
      SubdomainID id = _mesh->getSubdomainID(subdomain_name);
      _block_ids.insert(id);
    }
    if (_stagnation_direction.size() != _stagnation_boundary.size() * _dim)
      paramError("stagnation_flow_direction",
                 "Size is not the same as the number of boundaries in 'stagnation_boundary' times "
                 "the mesh dimension");
 
    // FIXME: need to check boundaries are non-overlapping and enclose the blocks
 
    auto var_type = AddVariableAction::variableType(_fe_type);
    auto base_params = _factory.getValidParams(var_type);
    base_params.set<MooseEnum>("order") = _fe_type.order.get_order();
    base_params.set<MooseEnum>("family") = Moose::stringify(_fe_type.family);
    if (_block_ids.size() != 0)
      for (const SubdomainID & id : _block_ids)
        base_params.set<std::vector<SubdomainName>>("block").push_back(Moose::stringify(id));
 
    // add primal variables
    InputParameters params(base_params);
    params.set<std::vector<Real>>("scaling") = {getParam<Real>("density_scaling")};
    _problem->addVariable(var_type, NS::density, params);
 
    auto mscaling = getParam<RealVectorValue>("momentum_scaling");
    params.set<std::vector<Real>>("scaling") = {mscaling(0)};
    _problem->addVariable(var_type, NS::momentum_x, params);
    if (_dim >= 2)
    {
      params.set<std::vector<Real>>("scaling") = {mscaling(1)};
      _problem->addVariable(var_type, NS::momentum_y, params);
    }
    if (_dim >= 3)
    {
      params.set<std::vector<Real>>("scaling") = {mscaling(2)};
      _problem->addVariable(var_type, NS::momentum_z, params);
    }
    params.set<std::vector<Real>>("scaling") = {getParam<Real>("total_energy_density_scaling")};
    _problem->addVariable(var_type, NS::total_energy_density, params);
 
    // Add Aux variables.  These are all required in order for the code
    // to run, so they should not be independently selectable by the
    // user.
    _problem->addAuxVariable(var_type, NS::velocity_x, base_params);
    if (_dim >= 2)
      _problem->addAuxVariable(var_type, NS::velocity_y, base_params);
    if (_dim >= 3)
      _problem->addAuxVariable(var_type, NS::velocity_z, base_params);
    _problem->addAuxVariable(var_type, _pressure_variable_name, base_params);
    _problem->addAuxVariable(var_type, NS::temperature, base_params);
    _problem->addAuxVariable(var_type, NS::specific_total_enthalpy, base_params);
    _problem->addAuxVariable(var_type, NS::mach_number, base_params);
 
    // Needed for FluidProperties calculations
    _problem->addAuxVariable(var_type, NS::specific_internal_energy, base_params);
    _problem->addAuxVariable(var_type, NS::specific_volume, base_params);
  }
 
  if (_current_task == "add_navier_stokes_kernels")
  {
    if (_type == "transient")
      addNSTimeKernels();
 
    // Add all the inviscid flux Kernels.
    addNSMassInviscidFlux();
    addNSEnergyInviscidFlux();
    for (unsigned int component = 0; component < _dim; ++component)
      addNSMomentumInviscidFlux(component);
 
    // Add SUPG Kernels
    addNSSUPGMass();
    addNSSUPGEnergy();
    for (unsigned int component = 0; component < _dim; ++component)
      addNSSUPGMomentum(component);
 
    // Add AuxKernels.
    addPressureOrTemperatureAux("PressureAux");
    addPressureOrTemperatureAux("TemperatureAux");
    addSpecificTotalEnthalpyAux();
    addNSMachAux();
    addNSInternalEnergyAux();
    addSpecificVolumeComputation();
    for (unsigned int component = 0; component < _dim; ++component)
      addNSVelocityAux(component);
  }
 
  if (_current_task == "add_navier_stokes_bcs")
  {
    if (_stagnation_boundary.size() > 0)
    {
      addNSMassWeakStagnationBC();
      addNSEnergyWeakStagnationBC();
      for (unsigned int component = 0; component < _dim; ++component)
        addNSMomentumWeakStagnationBC(component);
    }
 
    if (_no_penetration_boundary.size() > 0)
    {
      for (unsigned int component = 0; component < _dim; ++component)
        addNoPenetrationBC(component);
    }
 
    if (_static_pressure_boundary.size() > 0)
    {
      addNSMassUnspecifiedNormalFlowBC();
      addNSEnergyInviscidSpecifiedPressureBC();
      for (unsigned int component = 0; component < _dim; ++component)
        addNSMomentumInviscidSpecifiedPressureBC(component);
    }
  }
 
  if (_current_task == "add_navier_stokes_ics")
  {
    // add ICs for primal variables
    std::vector<VariableName> vars;
    vars.push_back(NS::density);
    vars.push_back(NS::momentum_x);
    if (_dim >= 2)
      vars.push_back(NS::momentum_y);
    if (_dim >= 3)
      vars.push_back(NS::momentum_z);
    vars.push_back(NS::total_energy_density);
    for (const auto & name : vars)
    {
      InputParameters params = _factory.getValidParams("NSInitialCondition");
      params.set<VariableName>("variable") = name;
      params.set<Real>("initial_pressure") = _initial_pressure;
      params.set<Real>("initial_temperature") = _initial_temperature;
      params.set<RealVectorValue>("initial_velocity") = _initial_velocity;
      params.set<UserObjectName>("fluid_properties") = _fp_name;
      _problem->addInitialCondition("NSInitialCondition", name + std::string("_ic"), params);
    }
 
    // add ICs for aux variables (possibly we do not need this)
    std::vector<VariableName> auxs;
    auxs.push_back(NS::velocity_x);
    if (_dim >= 2)
      auxs.push_back(NS::velocity_y);
    if (_dim >= 3)
      auxs.push_back(NS::velocity_z);
 
    auxs.push_back(_pressure_variable_name);
    auxs.push_back(NS::temperature);
    auxs.push_back(NS::specific_total_enthalpy);
    auxs.push_back(NS::mach_number);
 
    // Needed for FluidProperties calculations
    auxs.push_back(NS::specific_internal_energy);
    auxs.push_back(NS::specific_volume);
    for (const auto & name : auxs)
    {
      InputParameters params = _factory.getValidParams("NSInitialCondition");
      params.set<VariableName>("variable") = name;
      params.set<Real>("initial_pressure") = _initial_pressure;
      params.set<Real>("initial_temperature") = _initial_temperature;
      params.set<RealVectorValue>("initial_velocity") = _initial_velocity;
      params.set<UserObjectName>("fluid_properties") = _fp_name;
      if (name == _pressure_variable_name)
        params.set<MooseEnum>("variable_type") = NS::pressure;
      _problem->addInitialCondition("NSInitialCondition", name + std::string("_ic"), params);
    }
  }
}

◆ addNoPenetrationBC()

void CNSAction::addNoPenetrationBC ( unsigned int component )

protected

Definition at line 600 of file CNSAction.C.

{
  const static std::string momentums[3] = {NS::momentum_x, NS::momentum_y, NS::momentum_z};
  const std::string kernel_type = "NSPressureNeumannBC";
  InputParameters params = _factory.getValidParams(kernel_type);
  params.set<NonlinearVariableName>("variable") = momentums[component];
  setBCCommonParams(params);
 
  // These BCs also need the component and couping to the pressure.
  params.set<unsigned int>("component") = component;
  params.set<CoupledName>(NS::pressure) = {_pressure_variable_name};
 
  params.set<std::vector<BoundaryName>>("boundary") = _no_penetration_boundary;
  _problem->addBoundaryCondition(
      kernel_type, momentums[component] + std::string("_no_penetration"), params);
}

Referenced by act().

◆ addNSEnergyInviscidFlux()

void CNSAction::addNSEnergyInviscidFlux ( )

protected

Definition at line 510 of file CNSAction.C.

{
  const std::string kernel_type = "NSEnergyInviscidFlux";
  InputParameters params = _factory.getValidParams(kernel_type);
  params.set<NonlinearVariableName>("variable") = NS::total_energy_density;
  setKernelCommonParams(params);
 
  // Extra stuff needed by energy equation
  params.set<CoupledName>(NS::specific_total_enthalpy) = {NS::specific_total_enthalpy};
 
  // Add the Kernel
  _problem->addKernel(kernel_type, "rhoE_if", params);
}

Referenced by act().

◆ addNSEnergyInviscidSpecifiedPressureBC()

void CNSAction::addNSEnergyInviscidSpecifiedPressureBC ( )

protected

Definition at line 656 of file CNSAction.C.

{
  const std::string kernel_type = "NSEnergyInviscidSpecifiedPressureBC";
  InputParameters params = _factory.getValidParams(kernel_type);
  params.set<NonlinearVariableName>("variable") = NS::total_energy_density;
  setBCCommonParams(params);
  // This BC also requires the current value of the temperature.
  params.set<CoupledName>(NS::temperature) = {NS::temperature};
  for (unsigned int i = 0; i < _static_pressure_boundary.size(); ++i)
  {
    params.set<std::vector<BoundaryName>>("boundary") = {_static_pressure_boundary[i]};
    params.set<Real>("specified_pressure") = _static_pressure[i];
    _problem->addBoundaryCondition(
        kernel_type, "rhoE_specified_pressure_outflow_" + Moose::stringify(i), params);
  }
}

Referenced by act().

◆ addNSEnergyWeakStagnationBC()

void CNSAction::addNSEnergyWeakStagnationBC ( )

protected

Definition at line 541 of file CNSAction.C.

{
  const std::string kernel_type = "NSEnergyWeakStagnationBC";
  InputParameters params = _factory.getValidParams(kernel_type);
  params.set<NonlinearVariableName>("variable") = NS::total_energy_density;
  setBCCommonParams(params);
  for (unsigned int i = 0; i < _stagnation_boundary.size(); ++i)
  {
    setStagnationBCCommonParams(params, i);
    _problem->addBoundaryCondition(
        kernel_type, "weak_stagnation_energy_inflow_" + Moose::stringify(i), params);
  }
}

Referenced by act().

◆ addNSInternalEnergyAux()

void CNSAction::addNSInternalEnergyAux ( )

protected

Definition at line 396 of file CNSAction.C.

{
  const std::string kernel_type = "NSInternalEnergyAux";
 
  InputParameters params = _factory.getValidParams(kernel_type);
  params.set<AuxVariableName>("variable") = NS::specific_internal_energy;
 
  // coupled variables
  params.set<CoupledName>(NS::density) = {NS::density};
  params.set<CoupledName>(NS::total_energy_density) = {NS::total_energy_density};
 
  // Couple the appropriate number of velocities
  coupleVelocities(params);
 
  _problem->addAuxKernel(kernel_type, "specific_internal_energy_auxkernel", params);
}

Referenced by act().

◆ addNSMachAux()

void CNSAction::addNSMachAux ( )

protected

Definition at line 414 of file CNSAction.C.

{
  const std::string kernel_type = "NSMachAux";
 
  InputParameters params = _factory.getValidParams(kernel_type);
  params.set<AuxVariableName>("variable") = NS::mach_number;
 
  // coupled variables
  params.set<CoupledName>(NS::specific_internal_energy) = {NS::specific_internal_energy};
  params.set<CoupledName>(NS::specific_volume) = {NS::specific_volume};
 
  // Couple the appropriate number of velocities
  coupleVelocities(params);
 
  params.set<UserObjectName>("fluid_properties") = _fp_name;
 
  _problem->addAuxKernel(kernel_type, "mach_auxkernel", params);
}

Referenced by act().

◆ addNSMassInviscidFlux()

void CNSAction::addNSMassInviscidFlux ( )

protected

Definition at line 483 of file CNSAction.C.

{
  const std::string kernel_type = "NSMassInviscidFlux";
  InputParameters params = _factory.getValidParams(kernel_type);
  params.set<NonlinearVariableName>("variable") = NS::density;
  setKernelCommonParams(params);
  _problem->addKernel(kernel_type, "rho_if", params);
}

Referenced by act().

◆ addNSMassUnspecifiedNormalFlowBC()

void CNSAction::addNSMassUnspecifiedNormalFlowBC ( )

protected

Definition at line 618 of file CNSAction.C.

{
  const std::string kernel_type = "NSMassUnspecifiedNormalFlowBC";
  InputParameters params = _factory.getValidParams(kernel_type);
  params.set<NonlinearVariableName>("variable") = NS::density;
  setBCCommonParams(params);
  for (unsigned int i = 0; i < _static_pressure_boundary.size(); ++i)
  {
    params.set<std::vector<BoundaryName>>("boundary") = {_static_pressure_boundary[i]};
    params.set<Real>("specified_pressure") = _static_pressure[i];
    _problem->addBoundaryCondition(kernel_type, "mass_outflow_" + Moose::stringify(i), params);
  }
}

Referenced by act().

◆ addNSMassWeakStagnationBC()

void CNSAction::addNSMassWeakStagnationBC ( )

protected

Definition at line 525 of file CNSAction.C.

{
  const std::string kernel_type = "NSMassWeakStagnationBC";
  InputParameters params = _factory.getValidParams(kernel_type);
  params.set<NonlinearVariableName>("variable") = NS::density;
  setBCCommonParams(params);
 
  for (unsigned int i = 0; i < _stagnation_boundary.size(); ++i)
  {
    setStagnationBCCommonParams(params, i);
    _problem->addBoundaryCondition(
        kernel_type, "weak_stagnation_mass_inflow_" + Moose::stringify(i), params);
  }
}

Referenced by act().

◆ addNSMomentumInviscidFlux()

void CNSAction::addNSMomentumInviscidFlux ( unsigned int component )

protected

Definition at line 493 of file CNSAction.C.

{
  const static std::string momentums[3] = {NS::momentum_x, NS::momentum_y, NS::momentum_z};
  const std::string kernel_type = "NSMomentumInviscidFlux";
  InputParameters params = _factory.getValidParams(kernel_type);
  params.set<NonlinearVariableName>("variable") = momentums[component];
  setKernelCommonParams(params);
 
  // Extra stuff needed by momentum Kernels
  params.set<CoupledName>(NS::pressure) = {_pressure_variable_name};
  params.set<unsigned int>("component") = component;
 
  // Add the Kernel
  _problem->addKernel(kernel_type, momentums[component] + std::string("if"), params);
}

Referenced by act().

◆ addNSMomentumInviscidSpecifiedPressureBC()

void CNSAction::addNSMomentumInviscidSpecifiedPressureBC ( unsigned int component )

protected

Definition at line 633 of file CNSAction.C.

{
  const static std::string momentums[3] = {NS::momentum_x, NS::momentum_y, NS::momentum_z};
  const std::string kernel_type = "NSMomentumInviscidSpecifiedPressureBC";
  InputParameters params = _factory.getValidParams(kernel_type);
  params.set<NonlinearVariableName>("variable") = momentums[component];
  setBCCommonParams(params);
 
  // These BCs also need the component.
  params.set<unsigned int>("component") = component;
 
  for (unsigned int i = 0; i < _static_pressure_boundary.size(); ++i)
  {
    params.set<std::vector<BoundaryName>>("boundary") = {_static_pressure_boundary[i]};
    params.set<Real>("specified_pressure") = _static_pressure[i];
    _problem->addBoundaryCondition(
        kernel_type,
        momentums[component] + std::string("_specified_pressure_outflow_") + Moose::stringify(i),
        params);
  }
}

Referenced by act().

◆ addNSMomentumWeakStagnationBC()

void CNSAction::addNSMomentumWeakStagnationBC ( unsigned int component )

protected

Definition at line 556 of file CNSAction.C.

{
  const static std::string momentums[3] = {NS::momentum_x, NS::momentum_y, NS::momentum_z};
 
  // Convective part
  {
    const std::string kernel_type = "NSMomentumConvectiveWeakStagnationBC";
    InputParameters params = _factory.getValidParams(kernel_type);
    params.set<NonlinearVariableName>("variable") = momentums[component];
    setBCCommonParams(params);
    // Momentum BCs also need the component.
    params.set<unsigned int>("component") = component;
    for (unsigned int i = 0; i < _stagnation_boundary.size(); ++i)
    {
      setStagnationBCCommonParams(params, i);
      _problem->addBoundaryCondition(kernel_type,
                                     std::string("weak_stagnation_") + momentums[component] +
                                         std::string("_convective_inflow_") + Moose::stringify(i),
                                     params);
    }
  }
 
  // Pressure part
  {
    const std::string kernel_type = "NSMomentumPressureWeakStagnationBC";
    InputParameters params = _factory.getValidParams(kernel_type);
    params.set<NonlinearVariableName>("variable") = momentums[component];
    setBCCommonParams(params);
    // Momentum BCs also need the component.
    params.set<unsigned int>("component") = component;
 
    for (unsigned int i = 0; i < _stagnation_boundary.size(); ++i)
    {
      setStagnationBCCommonParams(params, i);
 
      _problem->addBoundaryCondition(kernel_type,
                                     std::string("weak_stagnation_") + momentums[component] +
                                         std::string("_pressure_inflow_") + Moose::stringify(i),
                                     params);
    }
  }
}

Referenced by act().

◆ addNSSUPGEnergy()

void CNSAction::addNSSUPGEnergy ( )

protected

Definition at line 363 of file CNSAction.C.

{
  const std::string kernel_type = "NSSUPGEnergy";
  InputParameters params = _factory.getValidParams(kernel_type);
  params.set<NonlinearVariableName>("variable") = NS::total_energy_density;
  setKernelCommonParams(params);
 
  // SUPG Kernels also need temperature and specific_total_enthalpy currently.
  params.set<CoupledName>(NS::temperature) = {NS::temperature};
  params.set<CoupledName>(NS::specific_total_enthalpy) = {NS::specific_total_enthalpy};
 
  _problem->addKernel(kernel_type, "rhoE_supg", params);
}

Referenced by act().

◆ addNSSUPGMass()

void CNSAction::addNSSUPGMass ( )

protected

Definition at line 328 of file CNSAction.C.

{
  const std::string kernel_type = "NSSUPGMass";
  InputParameters params = _factory.getValidParams(kernel_type);
  params.set<NonlinearVariableName>("variable") = NS::density;
  setKernelCommonParams(params);
 
  // SUPG Kernels also need temperature and specific_total_enthalpy currently.
  params.set<CoupledName>(NS::temperature) = {NS::temperature};
  params.set<CoupledName>(NS::specific_total_enthalpy) = {NS::specific_total_enthalpy};
 
  _problem->addKernel(kernel_type, "rho_supg", params);
}

Referenced by act().

◆ addNSSUPGMomentum()

void CNSAction::addNSSUPGMomentum ( unsigned int component )

protected

Definition at line 343 of file CNSAction.C.

{
  const static std::string momentums[3] = {NS::momentum_x, NS::momentum_y, NS::momentum_z};
 
  const std::string kernel_type = "NSSUPGMomentum";
  InputParameters params = _factory.getValidParams(kernel_type);
  params.set<NonlinearVariableName>("variable") = momentums[component];
  setKernelCommonParams(params);
 
  // SUPG Kernels also need temperature and specific_total_enthalpy currently.
  params.set<CoupledName>(NS::temperature) = {NS::temperature};
  params.set<CoupledName>(NS::specific_total_enthalpy) = {NS::specific_total_enthalpy};
 
  // Momentum Kernels also need the component.
  params.set<unsigned int>("component") = component;
 
  _problem->addKernel(kernel_type, momentums[component] + std::string("_supg"), params);
}

Referenced by act().

◆ addNSTimeKernels()

void CNSAction::addNSTimeKernels ( )

protected

Definition at line 301 of file CNSAction.C.

{
  const std::string kernel_type = "TimeDerivative";
  InputParameters params = _factory.getValidParams(kernel_type);
  params.set<std::vector<SubdomainName>>("block") = _blocks;
 
  params.set<NonlinearVariableName>("variable") = NS::density;
  _problem->addKernel(kernel_type, NS::density + "_time_deriv", params);
 
  params.set<NonlinearVariableName>("variable") = NS::momentum_x;
  _problem->addKernel(kernel_type, NS::momentum_x + "_time_deriv", params);
  if (_dim >= 2)
  {
    params.set<NonlinearVariableName>("variable") = NS::momentum_y;
    _problem->addKernel(kernel_type, NS::momentum_y + "_time_deriv", params);
  }
  if (_dim >= 3)
  {
    params.set<NonlinearVariableName>("variable") = NS::momentum_z;
    _problem->addKernel(kernel_type, NS::momentum_z + "_time_deriv", params);
  }
 
  params.set<NonlinearVariableName>("variable") = NS::total_energy_density;
  _problem->addKernel(kernel_type, NS::total_energy_density + "_time_deriv", params);
}

Referenced by act().

◆ addNSVelocityAux()

void CNSAction::addNSVelocityAux ( unsigned int component )

protected

Definition at line 450 of file CNSAction.C.

{
  const std::string kernel_type = "NSVelocityAux";
  const static std::string velocities[3] = {NS::velocity_x, NS::velocity_y, NS::velocity_z};
  const static std::string momentums[3] = {NS::momentum_x, NS::momentum_y, NS::momentum_z};
 
  InputParameters params = _factory.getValidParams(kernel_type);
  params.set<AuxVariableName>("variable") = velocities[component];
 
  // coupled variables
  params.set<CoupledName>(NS::density) = {NS::density};
  params.set<CoupledName>("momentum") = {momentums[component]};
  params.set<UserObjectName>("fluid_properties") = _fp_name;
 
  _problem->addAuxKernel(kernel_type, velocities[component] + "_auxkernel", params);
}

Referenced by act().

◆ addPressureOrTemperatureAux()

void CNSAction::addPressureOrTemperatureAux ( const std::string & kernel_type )

protected

Definition at line 468 of file CNSAction.C.

{
  InputParameters params = _factory.getValidParams(kernel_type);
  std::string var_name = (kernel_type == "PressureAux" ? _pressure_variable_name : NS::temperature);
  params.set<AuxVariableName>("variable") = var_name;
 
  // coupled variables
  params.set<CoupledName>("e") = {NS::specific_internal_energy};
  params.set<CoupledName>("v") = {NS::specific_volume};
  params.set<UserObjectName>("fp") = _fp_name;
 
  _problem->addAuxKernel(kernel_type, var_name + "_auxkernel", params);
}

Referenced by act().

◆ addSpecificTotalEnthalpyAux()

void CNSAction::addSpecificTotalEnthalpyAux ( )

protected

Definition at line 434 of file CNSAction.C.

{
  const std::string kernel_type = "NSSpecificTotalEnthalpyAux";
 
  InputParameters params = _factory.getValidParams(kernel_type);
  params.set<AuxVariableName>("variable") = NS::specific_total_enthalpy;
 
  // coupled variables
  params.set<CoupledName>(NS::density) = {NS::density};
  params.set<CoupledName>(NS::total_energy_density) = {NS::total_energy_density};
  params.set<CoupledName>(NS::pressure) = {_pressure_variable_name};
 
  _problem->addAuxKernel(kernel_type, "specific_total_enthalpy_auxkernel", params);
}

Referenced by act().

◆ addSpecificVolumeComputation()

void CNSAction::addSpecificVolumeComputation ( )

protected

Definition at line 378 of file CNSAction.C.

{
  const std::string kernel_type = "ParsedAux";
 
  InputParameters params = _factory.getValidParams(kernel_type);
  params.set<AuxVariableName>("variable") = NS::specific_volume;
 
  // arguments
  params.set<CoupledName>("coupled_variables") = {NS::density};
 
  // expression
  std::string function = "if(" + NS::density + " = 0, 1e10, 1 / " + NS::density + ")";
  params.set<std::string>("expression") = function;
 
  _problem->addAuxKernel(kernel_type, "specific_volume_auxkernel", params);
}

Referenced by act().

◆ coupleMomentums()

void CNSAction::coupleMomentums ( InputParameters & params )

protected

Definition at line 733 of file CNSAction.C.

{
  params.set<CoupledName>(NS::momentum_x) = {NS::momentum_x};
 
  if (_dim >= 2)
    params.set<CoupledName>(NS::momentum_y) = {NS::momentum_y};
 
  if (_dim >= 3)
    params.set<CoupledName>(NS::momentum_z) = {NS::momentum_z};
}

Referenced by setBCCommonParams(), and setKernelCommonParams().

◆ coupleVelocities()

void CNSAction::coupleVelocities ( InputParameters & params )

protected

Definition at line 721 of file CNSAction.C.

{
  params.set<CoupledName>(NS::velocity_x) = {NS::velocity_x};
 
  if (_dim >= 2)
    params.set<CoupledName>(NS::velocity_y) = {NS::velocity_y};
 
  if (_dim >= 3)
    params.set<CoupledName>(NS::velocity_z) = {NS::velocity_z};
}

Referenced by addNSInternalEnergyAux(), addNSMachAux(), setBCCommonParams(), and setKernelCommonParams().

◆ setBCCommonParams()

void CNSAction::setBCCommonParams ( InputParameters & params )

protected

Definition at line 691 of file CNSAction.C.

{
  // coupled variables
  params.set<CoupledName>(NS::density) = {NS::density};
  params.set<CoupledName>(NS::total_energy_density) = {NS::total_energy_density};
 
  // Couple the appropriate number of velocities
  coupleVelocities(params);
  coupleMomentums(params);
 
  // FluidProperties object
  params.set<UserObjectName>("fluid_properties") = _fp_name;
}

Referenced by addNoPenetrationBC(), addNSEnergyInviscidSpecifiedPressureBC(), addNSEnergyWeakStagnationBC(), addNSMassUnspecifiedNormalFlowBC(), addNSMassWeakStagnationBC(), addNSMomentumInviscidSpecifiedPressureBC(), and addNSMomentumWeakStagnationBC().

◆ setKernelCommonParams()

void CNSAction::setKernelCommonParams ( InputParameters & params )

protected

Definition at line 674 of file CNSAction.C.

{
  params.set<std::vector<SubdomainName>>("block") = _blocks;
 
  // coupled variables
  params.set<CoupledName>(NS::density) = {NS::density};
  params.set<CoupledName>(NS::total_energy_density) = {NS::total_energy_density};
 
  // Couple the appropriate number of velocities
  coupleVelocities(params);
  coupleMomentums(params);
 
  // FluidProperties object
  params.set<UserObjectName>("fluid_properties") = _fp_name;
}

Referenced by addNSEnergyInviscidFlux(), addNSMassInviscidFlux(), addNSMomentumInviscidFlux(), addNSSUPGEnergy(), addNSSUPGMass(), and addNSSUPGMomentum().

◆ setStagnationBCCommonParams()

void CNSAction::setStagnationBCCommonParams	(	InputParameters &	params,
		unsigned int	i
	)

protected

Definition at line 706 of file CNSAction.C.

{
  params.set<std::vector<BoundaryName>>("boundary") = {_stagnation_boundary[i]};
  params.set<Real>("stagnation_pressure") = _stagnation_pressure[i];
  params.set<Real>("stagnation_temperature") = _stagnation_temperature[i];
  params.set<Real>("sx") = _stagnation_direction[_dim * i];
  if (_dim == 1)
    params.set<Real>("sy") = 0;
  if (_dim >= 2)
    params.set<Real>("sy") = _stagnation_direction[_dim * i + 1];
  if (_dim >= 3)
    params.set<Real>("sz") = _stagnation_direction[_dim * i + 2];
}

Referenced by addNSEnergyWeakStagnationBC(), addNSMassWeakStagnationBC(), and addNSMomentumWeakStagnationBC().

◆ validParams()

InputParameters CNSAction::validParams ( )

static

Definition at line 32 of file CNSAction.C.

{
  InputParameters params = Action::validParams();
  params.addClassDescription("This class allows us to have a section of the input file like the "
                             "following which automatically adds Kernels and AuxKernels for all "
                             "the required nonlinear and auxiliary variables.");
 
  MooseEnum type("steady-state transient", "steady-state");
  params.addParam<MooseEnum>("equation_type", type, "Navier-Stokes equation type");
 
  params.addParam<std::vector<SubdomainName>>(
      "block", {}, "The list of block ids (SubdomainID) on which NS equation is defined on");
 
  params.addRequiredParam<UserObjectName>("fluid_properties",
                                          "The name of the user object for fluid properties");
 
  params.addParam<std::vector<BoundaryName>>(
      "stagnation_boundary", std::vector<BoundaryName>(), "Stagnation boundaries");
  params.addParam<std::vector<Real>>(
      "stagnation_pressure", std::vector<Real>(), "Pressure on stagnation boundaries");
  params.addParam<std::vector<Real>>(
      "stagnation_temperature", std::vector<Real>(), "Temperature on stagnation boundaries");
  params.addParam<std::vector<Real>>(
      "stagnation_flow_direction", std::vector<Real>(), "Flow directions on stagnation boundaries");
  params.addParam<std::vector<BoundaryName>>(
      "no_penetration_boundary", std::vector<BoundaryName>(), "No-penetration boundaries");
  params.addParam<std::vector<BoundaryName>>(
      "static_pressure_boundary", std::vector<BoundaryName>(), "Static pressure boundaries");
  params.addParam<std::vector<Real>>(
      "static_pressure", std::vector<Real>(), "Static pressure on boundaries");
 
  MooseEnum families(AddVariableAction::getNonlinearVariableFamilies(), "LAGRANGE");
  MooseEnum orders(AddVariableAction::getNonlinearVariableOrders(), "FIRST");
  params.addParam<MooseEnum>(
      "family", families, "Specifies the family of FE shape functions to use for this variable");
  params.addParam<MooseEnum>("order",
                             orders,
                             "Specifies the order of the FE shape function to use "
                             "for this variable (additional orders not listed are "
                             "allowed)");
  params.addParam<Real>("density_scaling", 1, "Scaling for the density variable");
  params.addParam<RealVectorValue>(
      "momentum_scaling", RealVectorValue(1, 1, 1), "Scaling for the momentum variables");
  params.addParam<Real>("total_energy_density_scaling", 1, "Scaling for the total-energy variable");
 
  params.addRequiredParam<Real>("initial_pressure",
                                "The initial pressure, assumed constant everywhere");
  params.addRequiredParam<Real>("initial_temperature",
                                "The initial temperature, assumed constant everywhere");
  params.addRequiredParam<RealVectorValue>("initial_velocity",
                                           "The initial velocity, assumed constant everywhere");
 
  params.addParamNamesToGroup("equation_type block fluid_properties", "Base");
  params.addParamNamesToGroup(
      "stagnation_boundary stagnation_pressure stagnation_temperature "
      "stagnation_flow_direction no_penetration_boundary static_pressure_boundary static_pressure",
      "BoundaryCondition");
  params.addParamNamesToGroup(
      "family order density_scaling momentum_scaling total_energy_density_scaling", "Variable");
  params.addParam<std::string>("pressure_variable_name",
                               "A name for the pressure variable. If this is not provided, a "
                               "sensible default will be used.");
  return params;
}

Member Data Documentation

◆ _block_ids

std::set<SubdomainID> CNSAction::_block_ids

protected

Subdomain IDs.

Definition at line 113 of file CNSAction.h.

Referenced by act().

◆ _blocks

std::vector<SubdomainName> CNSAction::_blocks

protected

Subdomains Navier-Stokes equation is defined on.

Definition at line 87 of file CNSAction.h.

Referenced by act(), addNSTimeKernels(), and setKernelCommonParams().

◆ _dim

unsigned int CNSAction::_dim

protected

Mesh dimension.

Definition at line 111 of file CNSAction.h.

Referenced by act(), addNSTimeKernels(), coupleMomentums(), coupleVelocities(), and setStagnationBCCommonParams().

◆ _fe_type

libMesh::FEType CNSAction::_fe_type

protected

FE type for various variables.

Definition at line 103 of file CNSAction.h.

Referenced by act().

◆ _fp_name

UserObjectName CNSAction::_fp_name

protected

Name of the FluidProperties object to pass on to Kernels.

Definition at line 85 of file CNSAction.h.

Referenced by act(), addNSMachAux(), addNSVelocityAux(), addPressureOrTemperatureAux(), setBCCommonParams(), and setKernelCommonParams().

◆ _initial_pressure

Real CNSAction::_initial_pressure

protected

Initial value for pressure.

Definition at line 105 of file CNSAction.h.

Referenced by act().

◆ _initial_temperature

Real CNSAction::_initial_temperature

protected

Initial value for temperature.

Definition at line 107 of file CNSAction.h.

Referenced by act().

◆ _initial_velocity

RealVectorValue CNSAction::_initial_velocity

protected

Initial value for velocity.

Definition at line 109 of file CNSAction.h.

Referenced by act().

◆ _no_penetration_boundary

std::vector<BoundaryName> CNSAction::_no_penetration_boundary

protected

Boundaries no-penetration BC applies.

Definition at line 97 of file CNSAction.h.

Referenced by act(), and addNoPenetrationBC().

◆ _pressure_variable_name

const std::string CNSAction::_pressure_variable_name

protected

pressure variable name

Definition at line 115 of file CNSAction.h.

Referenced by act(), addNoPenetrationBC(), addNSMomentumInviscidFlux(), addPressureOrTemperatureAux(), and addSpecificTotalEnthalpyAux().

◆ _stagnation_boundary

std::vector<BoundaryName> CNSAction::_stagnation_boundary

protected

Boundaries stagnation BC applies.

Definition at line 89 of file CNSAction.h.

Referenced by act(), addNSEnergyWeakStagnationBC(), addNSMassWeakStagnationBC(), addNSMomentumWeakStagnationBC(), CNSAction(), and setStagnationBCCommonParams().

◆ _stagnation_direction

std::vector<Real> CNSAction::_stagnation_direction

protected

Flow directions on stagnation boundaries.

Definition at line 95 of file CNSAction.h.

Referenced by act(), and setStagnationBCCommonParams().

◆ _stagnation_pressure

std::vector<Real> CNSAction::_stagnation_pressure

protected

Pressures on stagnation boundaries.

Definition at line 91 of file CNSAction.h.

Referenced by CNSAction(), and setStagnationBCCommonParams().

◆ _stagnation_temperature

std::vector<Real> CNSAction::_stagnation_temperature

protected

Temperatures on stagnation boundaries.

Definition at line 93 of file CNSAction.h.

Referenced by CNSAction(), and setStagnationBCCommonParams().

◆ _static_pressure

std::vector<Real> CNSAction::_static_pressure

protected

Pressures on static pressure boundaries.

Definition at line 101 of file CNSAction.h.

Referenced by addNSEnergyInviscidSpecifiedPressureBC(), addNSMassUnspecifiedNormalFlowBC(), addNSMomentumInviscidSpecifiedPressureBC(), and CNSAction().

◆ _static_pressure_boundary

std::vector<BoundaryName> CNSAction::_static_pressure_boundary

protected

Boundaries static pressure BC applies.

Definition at line 99 of file CNSAction.h.

Referenced by act(), addNSEnergyInviscidSpecifiedPressureBC(), addNSMassUnspecifiedNormalFlowBC(), addNSMomentumInviscidSpecifiedPressureBC(), and CNSAction().

◆ _type

MooseEnum CNSAction::_type

protected

Equation type, transient or steady-state.

Definition at line 83 of file CNSAction.h.

Referenced by act().

The documentation for this class was generated from the following files:

navier_stokes/include/actions/CNSAction.h
navier_stokes/src/actions/CNSAction.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CNSAction()

Member Function Documentation

◆ act()

◆ addNoPenetrationBC()

◆ addNSEnergyInviscidFlux()

◆ addNSEnergyInviscidSpecifiedPressureBC()

◆ addNSEnergyWeakStagnationBC()

◆ addNSInternalEnergyAux()

◆ addNSMachAux()

◆ addNSMassInviscidFlux()

◆ addNSMassUnspecifiedNormalFlowBC()

◆ addNSMassWeakStagnationBC()

◆ addNSMomentumInviscidFlux()

◆ addNSMomentumInviscidSpecifiedPressureBC()

◆ addNSMomentumWeakStagnationBC()

◆ addNSSUPGEnergy()

◆ addNSSUPGMass()

◆ addNSSUPGMomentum()

◆ addNSTimeKernels()

◆ addNSVelocityAux()

◆ addPressureOrTemperatureAux()

◆ addSpecificTotalEnthalpyAux()

◆ addSpecificVolumeComputation()

◆ coupleMomentums()

◆ coupleVelocities()

◆ setBCCommonParams()

◆ setKernelCommonParams()

◆ setStagnationBCCommonParams()

◆ validParams()

Member Data Documentation

◆ _block_ids

◆ _blocks

◆ _dim

◆ _fe_type

◆ _fp_name

◆ _initial_pressure

◆ _initial_temperature

◆ _initial_velocity

◆ _no_penetration_boundary

◆ _pressure_variable_name

◆ _stagnation_boundary

◆ _stagnation_direction

◆ _stagnation_pressure

◆ _stagnation_temperature

◆ _static_pressure

◆ _static_pressure_boundary

◆ _type