WCNSFVCoupledAdvectionPhysicsHelper Class Reference

Helper class to interact with a flow and turbulence physics for a Physics that solves an advection problem using incompressible or weakly-compressible finite volume. More...

#include <WCNSFVCoupledAdvectionPhysicsHelper.h>

Inheritance diagram for WCNSFVCoupledAdvectionPhysicsHelper:

Public Member Functions
	WCNSFVCoupledAdvectionPhysicsHelper (const NavierStokesPhysicsBase *derived_physics)
const WCNSFVFlowPhysicsBase *	getCoupledFlowPhysics () const
const WCNSFVTurbulencePhysicsBase *	getCoupledTurbulencePhysics () const
MooseFunctorName	getPorosityFunctorName (bool smoothed) const
	Return the porosity functor name. More...
const MooseFunctorName &	densityName () const
const MooseFunctorName &	dynamicViscosityName () const

Static Public Member Functions
static InputParameters	validParams ()

Protected Attributes
const NavierStokesPhysicsBase *	_advection_physics
	The Physics class using this helper. More...
const WCNSFVFlowPhysicsBase *	_flow_equations_physics
	Flow physics. More...
const WCNSFVTurbulencePhysicsBase *	_turbulence_physics
	Turbulence. More...
bool	_has_turbulence_model
	Because of the Modules/navierStokesFV syntax, a turbulence physics often exists without a model we save (_turbulence_physics && _turbulence_physics->hasTurbulenceModel()) in this attribute. More...
const MooseEnum	_compressibility
	Compressibility type, can be compressible, incompressible or weakly-compressible. More...
const bool	_porous_medium_treatment
	Switch to show if porous medium treatment is requested or not. More...
const std::vector< std::string >	_velocity_names
	Velocity names. More...
const NonlinearVariableName	_pressure_name
	Pressure name. More...
const MooseFunctorName	_density_name
	Name of the density material property. More...
const MooseFunctorName	_dynamic_viscosity_name
	Name of the dynamic viscosity material property. More...
const MooseEnum	_velocity_interpolation
	The velocity / momentum face interpolation method for advecting other quantities. More...

Detailed Description

Helper class to interact with a flow and turbulence physics for a Physics that solves an advection problem using incompressible or weakly-compressible finite volume.

Definition at line 22 of file WCNSFVCoupledAdvectionPhysicsHelper.h.

Constructor & Destructor Documentation

WCNSFVCoupledAdvectionPhysicsHelper()

WCNSFVCoupledAdvectionPhysicsHelper::WCNSFVCoupledAdvectionPhysicsHelper

(

const NavierStokesPhysicsBase *

derived_physics

)

Definition at line 32 of file WCNSFVCoupledAdvectionPhysicsHelper.C.

  : _advection_physics(derived_physics),
    _flow_equations_physics(getCoupledFlowPhysics()),
    _compressibility(_flow_equations_physics->compressibility()),
    _porous_medium_treatment(_flow_equations_physics->porousMediumTreatment()),
    _velocity_names(_flow_equations_physics->getVelocityNames()),
    _pressure_name(_flow_equations_physics->getPressureName()),
    _density_name(_flow_equations_physics->densityName()),
    _dynamic_viscosity_name(_flow_equations_physics->dynamicViscosityName()),
    _velocity_interpolation(_flow_equations_physics->getVelocityFaceInterpolationMethod())
{
}

Member Function Documentation

densityName()

const MooseFunctorName& WCNSFVCoupledAdvectionPhysicsHelper::densityName ( ) const

inline

Definition at line 36 of file WCNSFVCoupledAdvectionPhysicsHelper.h.

Referenced by WCNSFVTwoPhaseMixturePhysics::WCNSFVTwoPhaseMixturePhysics(), and WCNSLinearFVTwoPhaseMixturePhysics::WCNSLinearFVTwoPhaseMixturePhysics().

{ return _density_name; }

dynamicViscosityName()

const MooseFunctorName& WCNSFVCoupledAdvectionPhysicsHelper::dynamicViscosityName ( ) const

inline

Definition at line 37 of file WCNSFVCoupledAdvectionPhysicsHelper.h.

{ return _dynamic_viscosity_name; }

getCoupledFlowPhysics()

const WCNSFVFlowPhysicsBase * WCNSFVCoupledAdvectionPhysicsHelper::getCoupledFlowPhysics

(

)

const

Definition at line 53 of file WCNSFVCoupledAdvectionPhysicsHelper.C.

{
  // User passed it, just use that
  if (_advection_physics->isParamValid("coupled_flow_physics"))
    return _advection_physics->getCoupledPhysics<WCNSFVFlowPhysicsBase>(
        _advection_physics->getParam<PhysicsName>("coupled_flow_physics"));
  // Look for any physics of the right type, and check the block restriction
  else
  {
    const auto all_flow_physics =
        _advection_physics->getCoupledPhysics<const WCNSFVFlowPhysicsBase>();
    for (const auto physics : all_flow_physics)
      if (_advection_physics->checkBlockRestrictionIdentical(
              physics->name(), physics->blocks(), /*error_if_not_identical=*/false))
      {
        return physics;
      }
  }
  mooseError("No coupled flow Physics found of type derived from 'WCNSFVFlowPhysicsBase'. Use the "
             "'coupled_flow_physics' parameter to give the name of the desired "
             "WCNSFVFlowPhysicsBase-derived Physics to couple with");
}

getCoupledTurbulencePhysics()

const WCNSFVTurbulencePhysicsBase * WCNSFVCoupledAdvectionPhysicsHelper::getCoupledTurbulencePhysics

(

)

const

Definition at line 77 of file WCNSFVCoupledAdvectionPhysicsHelper.C.

Referenced by WCNSFVScalarTransportPhysicsBase::actOnAdditionalTasks(), and WCNSFVFluidHeatTransferPhysicsBase::actOnAdditionalTasks().

{
  // User passed it, just use that
  if (_advection_physics->isParamValid("coupled_turbulence_physics"))
    return _advection_physics->getCoupledPhysics<WCNSFVTurbulencePhysicsBase>(
        _advection_physics->getParam<PhysicsName>("coupled_turbulence_physics"));
  // Look for any physics of the right type, and check the block restriction
  else
  {
    const auto all_turbulence_physics =
        _advection_physics->getCoupledPhysics<const WCNSFVTurbulencePhysicsBase>(true);
    for (const auto physics : all_turbulence_physics)
      if (_advection_physics->checkBlockRestrictionIdentical(
              physics->name(), physics->blocks(), /*error_if_not_identical=*/false))
        return physics;
  }
  // Did not find one
  return nullptr;
}

getPorosityFunctorName()

MooseFunctorName WCNSFVCoupledAdvectionPhysicsHelper::getPorosityFunctorName

(

bool

smoothed

)

const

Return the porosity functor name.

It is important to forward to the Physics so we do not get the smoothing status wrong

Definition at line 47 of file WCNSFVCoupledAdvectionPhysicsHelper.C.

{
  return _flow_equations_physics->getPorosityFunctorName(smoothed);
}

validParams()

InputParameters WCNSFVCoupledAdvectionPhysicsHelper::validParams ( )

static

Definition at line 17 of file WCNSFVCoupledAdvectionPhysicsHelper.C.

Referenced by WCNSFVScalarTransportPhysicsBase::validParams(), WCNSFVFluidHeatTransferPhysicsBase::validParams(), and WCNSFVTurbulencePhysicsBase::validParams().

{
  InputParameters params = emptyInputParameters();
  params.addClassDescription("Class to facilitate coupling between a Physics defining flow "
                             "equations and other objects, notably advection Physics.");

  params.addParam<PhysicsName>("coupled_flow_physics",
                               "WCNSFVFlowPhysics generating the velocities");
  params.addParam<PhysicsName>("coupled_turbulence_physics",
                               "Turbulence Physics coupled with this Physics");
  params.addParamNamesToGroup("coupled_flow_physics coupled_turbulence_physics", "Coupled Physics");

  return params;
}

Member Data Documentation

_advection_physics

const NavierStokesPhysicsBase* WCNSFVCoupledAdvectionPhysicsHelper::_advection_physics

protected

The Physics class using this helper.

Definition at line 41 of file WCNSFVCoupledAdvectionPhysicsHelper.h.

Referenced by getCoupledFlowPhysics(), and getCoupledTurbulencePhysics().

_compressibility

const MooseEnum WCNSFVCoupledAdvectionPhysicsHelper::_compressibility

protected

Compressibility type, can be compressible, incompressible or weakly-compressible.

Definition at line 51 of file WCNSFVCoupledAdvectionPhysicsHelper.h.

Referenced by WCNSFVFluidHeatTransferPhysics::addEnergyTimeKernels().

_density_name

const MooseFunctorName WCNSFVCoupledAdvectionPhysicsHelper::_density_name

protected

Name of the density material property.

Definition at line 62 of file WCNSFVCoupledAdvectionPhysicsHelper.h.

Referenced by WCNSFVFluidHeatTransferPhysics::addEnergyInletBC(), WCNSLinearFVFluidHeatTransferPhysics::addEnergyTimeKernels(), WCNSFVFluidHeatTransferPhysics::addEnergyTimeKernels(), WCNSFVFluidHeatTransferPhysics::addEnergyWallBC(), WCNSFVTurbulencePhysics::addFlowTurbulenceKernels(), WCNSFVTurbulencePhysics::addFluidEnergyTurbulenceKernels(), WCNSFVFluidHeatTransferPhysics::addMaterials(), WCNSFVTurbulencePhysics::addMaterials(), WCNSFVTurbulencePhysicsBase::addMaterials(), WCNSFVScalarTransportPhysics::addScalarInletBC(), and densityName().

_dynamic_viscosity_name

const MooseFunctorName WCNSFVCoupledAdvectionPhysicsHelper::_dynamic_viscosity_name

protected

Name of the dynamic viscosity material property.

Definition at line 64 of file WCNSFVCoupledAdvectionPhysicsHelper.h.

Referenced by WCNSFVFluidHeatTransferPhysics::addEnergyWallBC(), WCNSFVTurbulencePhysics::addMaterials(), and dynamicViscosityName().

_flow_equations_physics

const WCNSFVFlowPhysicsBase* WCNSFVCoupledAdvectionPhysicsHelper::_flow_equations_physics

protected

Flow physics.

Definition at line 43 of file WCNSFVCoupledAdvectionPhysicsHelper.h.

Referenced by WCNSFVTwoPhaseMixturePhysics::addAdvectionSlipTerm(), WCNSFVTurbulencePhysicsBase::addAuxiliaryKernels(), WCNSFVTurbulencePhysics::addAxisymmetricTurbulentViscousSource(), WCNSFVFluidHeatTransferPhysics::addEnergyAdvectionKernels(), WCNSLinearFVFluidHeatTransferPhysics::addEnergyAdvectionKernels(), WCNSFVFluidHeatTransferPhysics::addEnergyHeatConductionKernels(), WCNSLinearFVFluidHeatTransferPhysics::addEnergyInletBC(), WCNSFVFluidHeatTransferPhysics::addEnergyInletBC(), WCNSLinearFVFluidHeatTransferPhysics::addEnergyOutletBC(), WCNSFVFluidHeatTransferPhysics::addEnergySeparatorBC(), WCNSFVFluidHeatTransferPhysics::addEnergyTimeKernels(), WCNSLinearFVFluidHeatTransferPhysics::addEnergyWallBC(), WCNSFVFluidHeatTransferPhysics::addEnergyWallBC(), WCNSFVTurbulencePhysics::addFlowTurbulenceKernels(), WCNSFVTurbulencePhysics::addFluidEnergyTurbulenceKernels(), WCNSFVTwoPhaseMixturePhysics::addFunctorMaterials(), WCNSLinearFVTurbulencePhysics::addFunctorMaterials(), WCNSFVTurbulencePhysics::addFVBCs(), WCNSLinearFVTurbulencePhysics::addFVBCs(), WCNSLinearFVTwoPhaseMixturePhysics::addFVKernels(), WCNSFVTwoPhaseMixturePhysics::addFVKernels(), WCNSFVFluidHeatTransferPhysicsBase::addInitialConditions(), WCNSFVTurbulencePhysicsBase::addInitialConditions(), WCNSLinearFVTurbulencePhysics::addKEpsilonAdvection(), WCNSFVTurbulencePhysics::addKEpsilonAdvection(), WCNSFVTurbulencePhysics::addKEpsilonDiffusion(), WCNSLinearFVTurbulencePhysics::addKEpsilonSink(), WCNSFVTurbulencePhysics::addKEpsilonSink(), WCNSLinearFVTurbulencePhysics::addKEpsilonTimeDerivatives(), WCNSFVFluidHeatTransferPhysics::addMaterials(), WCNSLinearFVFluidHeatTransferPhysics::addMaterials(), WCNSLinearFVTwoPhaseMixturePhysics::addMaterials(), WCNSFVTurbulencePhysicsBase::addMaterials(), WCNSLinearFVTwoPhaseMixturePhysics::addPhaseDriftFluxTerm(), WCNSFVTwoPhaseMixturePhysics::addPhaseDriftFluxTerm(), WCNSLinearFVScalarTransportPhysics::addScalarAdvectionKernels(), WCNSFVScalarTransportPhysics::addScalarAdvectionKernels(), WCNSLinearFVScalarTransportPhysics::addScalarInletBC(), WCNSFVScalarTransportPhysics::addScalarInletBC(), WCNSLinearFVScalarTransportPhysics::addScalarOutletBC(), WCNSLinearFVTurbulencePhysics::checkIntegrity(), WCNSLinearFVTwoPhaseMixturePhysics::checkIntegrity(), WCNSFVTurbulencePhysics::getNumberAlgebraicGhostingLayersNeeded(), WCNSLinearFVTurbulencePhysics::getNumberAlgebraicGhostingLayersNeeded(), WCNSFVFluidHeatTransferPhysicsBase::getNumberAlgebraicGhostingLayersNeeded(), WCNSFVScalarTransportPhysicsBase::getNumberAlgebraicGhostingLayersNeeded(), getPorosityFunctorName(), WCNSFVTurbulencePhysicsBase::retrieveCoupledPhysics(), WCNSFVFluidHeatTransferPhysicsBase::WCNSFVFluidHeatTransferPhysicsBase(), WCNSFVTwoPhaseMixturePhysics::WCNSFVTwoPhaseMixturePhysics(), WCNSLinearFVScalarTransportPhysics::WCNSLinearFVScalarTransportPhysics(), and WCNSLinearFVTwoPhaseMixturePhysics::WCNSLinearFVTwoPhaseMixturePhysics().

_has_turbulence_model

bool WCNSFVCoupledAdvectionPhysicsHelper::_has_turbulence_model

protected

Because of the Modules/navierStokesFV syntax, a turbulence physics often exists without a model we save (_turbulence_physics && _turbulence_physics->hasTurbulenceModel()) in this attribute.

Definition at line 48 of file WCNSFVCoupledAdvectionPhysicsHelper.h.

Referenced by WCNSFVScalarTransportPhysicsBase::actOnAdditionalTasks(), WCNSFVFluidHeatTransferPhysicsBase::actOnAdditionalTasks(), WCNSLinearFVFluidHeatTransferPhysics::addEnergyHeatConductionKernels(), WCNSLinearFVFluidHeatTransferPhysics::addMaterials(), WCNSLinearFVScalarTransportPhysics::addScalarDiffusionKernels(), and WCNSFVFluidHeatTransferPhysicsBase::defineEffectiveThermalDiffusionCoeffFunctors().

_porous_medium_treatment

const bool WCNSFVCoupledAdvectionPhysicsHelper::_porous_medium_treatment

protected

Switch to show if porous medium treatment is requested or not.

Definition at line 54 of file WCNSFVCoupledAdvectionPhysicsHelper.h.

Referenced by WCNSFVFluidHeatTransferPhysics::addEnergyAdvectionKernels(), WCNSFVFluidHeatTransferPhysics::addEnergyHeatConductionKernels(), WCNSFVFluidHeatTransferPhysics::addEnergyTimeKernels(), WCNSFVTurbulencePhysics::addFlowTurbulenceKernels(), WCNSFVTurbulencePhysics::addFluidEnergyTurbulenceKernels(), WCNSFVScalarTransportPhysics::addScalarAdvectionKernels(), WCNSFVFluidHeatTransferPhysicsBase::processThermalConductivity(), WCNSLinearFVFluidHeatTransferPhysics::WCNSLinearFVFluidHeatTransferPhysics(), and WCNSLinearFVScalarTransportPhysics::WCNSLinearFVScalarTransportPhysics().

_pressure_name

const NonlinearVariableName WCNSFVCoupledAdvectionPhysicsHelper::_pressure_name

protected

Pressure name.

Definition at line 59 of file WCNSFVCoupledAdvectionPhysicsHelper.h.

_turbulence_physics

const WCNSFVTurbulencePhysicsBase* WCNSFVCoupledAdvectionPhysicsHelper::_turbulence_physics

protected

Turbulence.

Definition at line 45 of file WCNSFVCoupledAdvectionPhysicsHelper.h.

Referenced by WCNSFVScalarTransportPhysicsBase::actOnAdditionalTasks(), WCNSFVFluidHeatTransferPhysicsBase::actOnAdditionalTasks(), and WCNSFVFluidHeatTransferPhysics::addEnergyWallBC().

_velocity_interpolation

const MooseEnum WCNSFVCoupledAdvectionPhysicsHelper::_velocity_interpolation

protected

The velocity / momentum face interpolation method for advecting other quantities.

Definition at line 67 of file WCNSFVCoupledAdvectionPhysicsHelper.h.

Referenced by WCNSFVFluidHeatTransferPhysics::addEnergyAdvectionKernels(), WCNSFVTurbulencePhysics::addKEpsilonAdvection(), and WCNSFVScalarTransportPhysics::addScalarAdvectionKernels().

_velocity_names

const std::vector<std::string> WCNSFVCoupledAdvectionPhysicsHelper::_velocity_names

protected

Velocity names.

Definition at line 57 of file WCNSFVCoupledAdvectionPhysicsHelper.h.

Referenced by WCNSFVTurbulencePhysicsBase::addAuxiliaryKernels(), WCNSFVFluidHeatTransferPhysics::addEnergyInletBC(), WCNSFVFluidHeatTransferPhysics::addEnergyWallBC(), WCNSFVTurbulencePhysics::addFlowTurbulenceKernels(), WCNSFVTurbulencePhysics::addFluidEnergyTurbulenceKernels(), WCNSFVTurbulencePhysics::addFVBCs(), WCNSLinearFVTurbulencePhysics::addFVBCs(), WCNSLinearFVTurbulencePhysics::addKEpsilonSink(), WCNSFVTurbulencePhysics::addKEpsilonSink(), WCNSFVTurbulencePhysics::addMaterials(), WCNSFVTurbulencePhysics::addScalarAdvectionTurbulenceKernels(), and WCNSFVScalarTransportPhysics::addScalarInletBC().

---

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

• navier_stokes/include/physics/WCNSFVCoupledAdvectionPhysicsHelper.h
• navier_stokes/src/physics/WCNSFVCoupledAdvectionPhysicsHelper.C