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:

[legend]

Public Member Functions
	WCNSFVCoupledAdvectionPhysicsHelper (const NavierStokesPhysicsBase *derived_physics)

const WCNSFVFlowPhysicsBase *	getCoupledFlowPhysics () const

const WCNSFVTurbulencePhysics *	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 WCNSFVTurbulencePhysics *	_turbulence_physics
	Turbulence. 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().

36 { return _density_name; }

WCNSFVCoupledAdvectionPhysicsHelper::_density_name

const MooseFunctorName _density_name

Name of the density material property.

Definition: WCNSFVCoupledAdvectionPhysicsHelper.h:59

◆ dynamicViscosityName()

const MooseFunctorName& WCNSFVCoupledAdvectionPhysicsHelper::dynamicViscosityName ( ) const

inline

Definition at line 37 of file WCNSFVCoupledAdvectionPhysicsHelper.h.

37 { return _dynamic_viscosity_name; }

WCNSFVCoupledAdvectionPhysicsHelper::_dynamic_viscosity_name

const MooseFunctorName _dynamic_viscosity_name

Name of the dynamic viscosity material property.

Definition: WCNSFVCoupledAdvectionPhysicsHelper.h:61

◆ 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 WCNSFVTurbulencePhysics * WCNSFVCoupledAdvectionPhysicsHelper::getCoupledTurbulencePhysics ( ) const

Definition at line 77 of file WCNSFVCoupledAdvectionPhysicsHelper.C.

Referenced by WCNSFVFluidHeatTransferPhysicsBase::actOnAdditionalTasks().

 {
   // User passed it, just use that
   if (_advection_physics->isParamValid("coupled_turbulence_physics"))
     return _advection_physics->getCoupledPhysics<WCNSFVTurbulencePhysics>(
         _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 WCNSFVTurbulencePhysics>(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 WCNSFVTurbulencePhysics::validParams(), WCNSFVScalarTransportPhysicsBase::validParams(), and WCNSFVFluidHeatTransferPhysicsBase::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;
 }