DefaultMultiAppFixedPointConvergence.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 "DefaultConvergenceBase.h"

class FEProblemBase;
class FixedPointSolve;

class DefaultMultiAppFixedPointConvergence : public DefaultConvergenceBase
{
public:
  static InputParameters validParams();

  DefaultMultiAppFixedPointConvergence(const InputParameters & parameters);

  virtual void initialize() override;
  virtual void preExecute() override;

  virtual MooseConvergenceStatus checkConvergence(unsigned int iter) override;

protected:
  void outputResidualNorm(const std::string & execute_on_str, Real old_norm, Real new_norm) const;

  void computeCustomConvergencePostprocessor(unsigned int iter);

  unsigned int _min_fixed_point_its;
  unsigned int _max_fixed_point_its;
  const bool _has_fixed_point_norm;
  const bool _fixed_point_force_norms;
  const bool _accept_max_it;
  const Real _fixed_point_rel_tol;
  const Real _fixed_point_abs_tol;
  const Real _custom_pp_rel_tol;
  const Real _custom_pp_abs_tol;

  Real _fixed_point_initial_norm;
  std::vector<Real> _fixed_point_timestep_begin_norm;
  std::vector<Real> _fixed_point_timestep_end_norm;

  const PostprocessorValue * const _fixed_point_custom_pp;
  Real _pp_old;
  Real _pp_new;
  Real _pp_scaling;
  std::ostringstream _pp_history;

  FEProblemBase & _fe_problem;
  FixedPointSolve & _fp_solve;
};