WCNSFVScalarTransportPhysicsBase.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* 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 "NavierStokesPhysicsBase.h"
#include "WCNSFVCoupledAdvectionPhysicsHelper.h"

#define registerWCNSFVScalarTransportBaseTasks(app_name, derived_name)                             \
  registerMooseAction(app_name, derived_name, "add_variables_physics");                            \
  registerMooseAction(app_name, derived_name, "add_ics_physics");                                  \
  registerMooseAction(app_name, derived_name, "add_fv_kernel");                                    \
  registerMooseAction(app_name, derived_name, "add_fv_bc");                                        \
  registerMooseAction(app_name, derived_name, "get_turbulence_physics")

class WCNSFVScalarTransportPhysicsBase : public NavierStokesPhysicsBase,
                                         public WCNSFVCoupledAdvectionPhysicsHelper
{
public:
  static InputParameters validParams();

  WCNSFVScalarTransportPhysicsBase(const InputParameters & parameters);

  const std::vector<NonlinearVariableName> & getAdvectedScalarNames() const
  {
    return _passive_scalar_names;
  }

  bool hasScalarEquations() const { return _has_scalar_equation; }

protected:
  virtual void actOnAdditionalTasks() override;
  virtual void addFVKernels() override;
  virtual void addFVBCs() override;
  virtual void setSlipVelocityParams(InputParameters & /* params */) const {}

  std::vector<NonlinearVariableName> _passive_scalar_names;
  const bool _has_scalar_equation;

  MultiMooseEnum _passive_scalar_inlet_types;
  std::vector<std::vector<MooseFunctorName>> _passive_scalar_inlet_functors;

  std::vector<MooseFunctorName> _passive_scalar_sources;
  std::vector<std::vector<MooseFunctorName>> _passive_scalar_coupled_sources;
  std::vector<std::vector<Real>> _passive_scalar_sources_coef;

private:
  virtual void addInitialConditions() override;

  virtual void addScalarTimeKernels() = 0;
  virtual void addScalarDiffusionKernels() = 0;
  virtual void addScalarAdvectionKernels() = 0;
  virtual void addScalarSourceKernels() = 0;

  virtual void addScalarInletBC() = 0;
  virtual void addScalarWallBC() = 0;
  virtual void addScalarOutletBC() = 0;

  virtual unsigned short getNumberAlgebraicGhostingLayersNeeded() const override;
};