SIMPLESolveBase.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

// Moose includes
#include "SolveObject.h"
#include "UserObjectInterface.h"
#include "PetscSupport.h"
#include "SolverParams.h"
#include "SegregatedSolverUtils.h"

// Libmesh includes
#include "libmesh/solver_configuration.h"
#include "libmesh/petsc_vector.h"
#include "libmesh/petsc_matrix.h"
#include "libmesh/equation_systems.h"

class SIMPLESolverConfiguration : public libMesh::SolverConfiguration
{
  virtual void configure_solver() override {}
};

class SIMPLESolveBase : public SolveObject, public UserObjectInterface
{
public:
  SIMPLESolveBase(Executioner & ex);

  static InputParameters validParams();

  virtual void setInnerSolve(SolveObject &) override
  {
    mooseError("Cannot set inner solve object for solves that inherit from SIMPLESolveBase");
  }

  virtual void linkRhieChowUserObject() = 0;

  void setupPressurePin();

  virtual void checkIntegrity() {}

protected:
  void checkDependentParameterError(const std::string & main_parameter,
                                    const std::vector<std::string> & dependent_parameters,
                                    const bool should_be_defined);

  virtual std::vector<std::pair<unsigned int, Real>> solveMomentumPredictor() = 0;

  virtual std::pair<unsigned int, Real> solvePressureCorrector() = 0;

  // ************************ Momentum Eq Variables ************************ //

  const std::vector<SolverSystemName> & _momentum_system_names;

  SIMPLESolverConfiguration _momentum_linear_control;

  const Real _momentum_l_abs_tol;

  Moose::PetscSupport::PetscOptions _momentum_petsc_options;

  const Real _momentum_equation_relaxation;

  // ************************ Pressure Eq Variables ************************ //

  const SolverSystemName & _pressure_system_name;

  SIMPLESolverConfiguration _pressure_linear_control;

  const Real _pressure_l_abs_tol;

  Moose::PetscSupport::PetscOptions _pressure_petsc_options;

  const Real _pressure_variable_relaxation;

  const bool _pin_pressure;

  const Real _pressure_pin_value;

  dof_id_type _pressure_pin_dof;

  // ************************ Energy Eq Variables ************************** //

  const bool _has_energy_system;

  const Real _energy_equation_relaxation;

  Moose::PetscSupport::PetscOptions _energy_petsc_options;

  SIMPLESolverConfiguration _energy_linear_control;

  const Real _energy_l_abs_tol;

  // ************************ Solid Energy Eq Variables *********************** //

  const bool _has_solid_energy_system;

  Moose::PetscSupport::PetscOptions _solid_energy_petsc_options;

  SIMPLESolverConfiguration _solid_energy_linear_control;

  const Real _solid_energy_l_abs_tol;

  // ************************ Passive Scalar Variables ************************ //

  const std::vector<SolverSystemName> & _passive_scalar_system_names;

  const bool _has_passive_scalar_systems;

  // The number(s) of the system(s) corresponding to the passive scalar equation(s)
  std::vector<unsigned int> _passive_scalar_system_numbers;

  const std::vector<Real> _passive_scalar_equation_relaxation;

  Moose::PetscSupport::PetscOptions _passive_scalar_petsc_options;

  SIMPLESolverConfiguration _passive_scalar_linear_control;

  const Real _passive_scalar_l_abs_tol;

  // ************************ Iteration control **************************** //

  const Real _momentum_absolute_tolerance;

  const Real _pressure_absolute_tolerance;

  const Real _energy_absolute_tolerance;

  const Real _solid_energy_absolute_tolerance;

  const std::vector<Real> _passive_scalar_absolute_tolerance;

  const unsigned int _num_iterations;

  const bool _continue_on_max_its;

  // ************************ Other Variables ****************************** //

  const bool _print_fields;
};