SingleVariableReturnMappingSolution.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://www.mooseframework.org
//*
//* 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 "InputParameters.h"
#include "ConsoleStream.h"
 
class SingleVariableReturnMappingSolution;
 
template <>
InputParameters validParams<SingleVariableReturnMappingSolution>();
 
class SingleVariableReturnMappingSolution
{
public:
  static InputParameters validParams();
 
  SingleVariableReturnMappingSolution(const InputParameters & parameters);
  virtual ~SingleVariableReturnMappingSolution() {}
 
protected:
  void returnMappingSolve(const Real effective_trial_stress,
                          Real & scalar,
                          const ConsoleStream & console);
 
  virtual Real minimumPermissibleValue(const Real effective_trial_stress) const;
 
  virtual Real maximumPermissibleValue(const Real effective_trial_stress) const;
 
  virtual Real initialGuess(const Real /*effective_trial_stress*/) { return 0.0; }
 
  virtual Real computeResidual(const Real effective_trial_stress, const Real scalar) = 0;
 
  virtual Real computeDerivative(const Real effective_trial_stress, const Real scalar) = 0;
 
  virtual Real computeReferenceResidual(const Real effective_trial_stress, const Real scalar) = 0;
 
  virtual void iterationFinalize(Real /*scalar*/) {}
 
  virtual void outputIterationStep(std::stringstream * iter_output,
                                   const unsigned int it,
                                   const Real effective_trial_stress,
                                   const Real scalar,
                                   const Real residual,
                                   const Real reference_residual);
 
  virtual void outputIterationSummary(std::stringstream * iter_output, const unsigned int total_it);
 
  bool _check_range;
 
  bool _line_search;
 
  bool _bracket_solution;
 
private:
  enum class InternalSolveOutput
  {
    NEVER,
    ON_ERROR,
    ALWAYS
  } _internal_solve_output_on;
 
  enum class SolveState
  {
    SUCCESS,
    NAN_INF,
    EXCEEDED_ITERATIONS
  };
 
  const unsigned int _max_its;
 
  const bool _internal_solve_full_iteration_history;
 
  Real _relative_tolerance;
 
  Real _absolute_tolerance;
 
  Real _acceptable_multiplier;
 
  const std::size_t _num_resids;
 
  std::vector<Real> _residual_history;
 
  unsigned int _iteration;
 
  Real _initial_residual;
  Real _residual;
 
  const std::string _svrms_name;
 
  SolveState internalSolve(const Real effective_trial_stress,
                           Real & scalar,
                           std::stringstream * iter_output = nullptr);
 
  bool converged(const Real residual, const Real reference);
 
  bool convergedAcceptable(const unsigned int it, const Real residual, const Real reference);
 
  void checkPermissibleRange(Real & scalar,
                             Real & scalar_increment,
                             const Real scalar_old,
                             const Real min_permissible_scalar,
                             const Real max_permissible_scalar,
                             std::stringstream * iter_output);
 
  void updateBounds(const Real scalar,
                    const Real residual,
                    const Real init_resid_sign,
                    Real & scalar_upper_bound,
                    Real & scalar_lower_bound,
                    std::stringstream * iter_output);
};