Base class that provides capability for Newton return mapping iterations on a single variable. More...

#include <SingleVariableReturnMappingSolution.h>

Inheritance diagram for SingleVariableReturnMappingSolution:

Public Member Functions
	SingleVariableReturnMappingSolution (const InputParameters &parameters)

virtual	~SingleVariableReturnMappingSolution ()

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
void	returnMappingSolve (const Real effective_trial_stress, Real &scalar, const ConsoleStream &console)
	Perform the return mapping iterations. More...

virtual Real	minimumPermissibleValue (const Real effective_trial_stress) const
	Compute the minimum permissible value of the scalar. More...

virtual Real	maximumPermissibleValue (const Real effective_trial_stress) const
	Compute the maximum permissible value of the scalar. More...

virtual Real	initialGuess (const Real)
	Compute an initial guess for the value of the scalar. More...

virtual Real	computeResidual (const Real effective_trial_stress, const Real scalar)=0
	Compute the residual for a predicted value of the scalar. More...

virtual Real	computeDerivative (const Real effective_trial_stress, const Real scalar)=0
	Compute the derivative of the residual as a function of the scalar variable. More...

virtual Real	computeReferenceResidual (const Real effective_trial_stress, const Real scalar)=0
	Compute a reference quantity to be used for checking relative convergence. More...

virtual void	iterationFinalize (Real)
	Finalize internal state variables for a model for a given iteration. More...

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)
	Output information for a single iteration step to build the convergence history of the model. More...

virtual void	outputIterationSummary (std::stringstream *iter_output, const unsigned int total_it)
	Output summary information for the convergence history of the model. More...

Protected Attributes
bool	_check_range
	Whether to check to see whether iterative solution is within admissible range, and set within that range if outside. More...

bool	_line_search
	Whether to use line searches to improve convergence. More...

bool	_bracket_solution
	Whether to save upper and lower bounds of root for scalar, and set solution to the midpoint between those bounds if outside them. More...

Private Types
enum	InternalSolveOutput { InternalSolveOutput::NEVER, InternalSolveOutput::ON_ERROR, InternalSolveOutput::ALWAYS }

enum	SolveState { SolveState::SUCCESS, SolveState::NAN_INF, SolveState::EXCEEDED_ITERATIONS }

Private Member Functions
SolveState	internalSolve (const Real effective_trial_stress, Real &scalar, std::stringstream *iter_output=nullptr)
	Method called from within this class to perform the actual return mappping iterations. More...

bool	converged (const Real residual, const Real reference)
	Check to see whether the residual is within the convergence limits. More...

bool	convergedAcceptable (const unsigned int it, const Real residual, const Real reference)
	Check to see whether the residual is within acceptable convergence limits. More...

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)
	Check to see whether solution is within admissible range, and set it within that range if it is not. More...

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)
	Update the upper and lower bounds of the root for the effective inelastic strain. More...

Private Attributes
enum SingleVariableReturnMappingSolution::InternalSolveOutput	_internal_solve_output_on

const unsigned int	_max_its
	Maximum number of return mapping iterations. More...

const bool	_internal_solve_full_iteration_history
	Whether to output iteration information all the time (regardless of whether iterations converge) More...

Real	_relative_tolerance
	Relative convergence tolerance. More...

Real	_absolute_tolerance
	Absolute convergence tolerance. More...

Real	_acceptable_multiplier
	Multiplier applied to relative and absolute tolerances for acceptable convergence. More...

const std::size_t	_num_resids
	Number of residuals to be stored in history. More...

std::vector< Real >	_residual_history
	History of residuals used to check whether progress is still being made on decreasing the residual. More...

unsigned int	_iteration
	iteration number More...

const std::string	_svrms_name
	MOOSE input name of the object performing the solve. More...


Real	_initial_residual
	Residual values, kept as members to retain solver state for summary outputting. More...

Real	_residual

Detailed Description

Base class that provides capability for Newton return mapping iterations on a single variable.

Definition at line 24 of file SingleVariableReturnMappingSolution.h.

Member Enumeration Documentation

◆ InternalSolveOutput

enum SingleVariableReturnMappingSolution::InternalSolveOutput

strongprivate

Enumerator
NEVER
ON_ERROR
ALWAYS

Definition at line 130 of file SingleVariableReturnMappingSolution.h.

   {
     NEVER,
     ON_ERROR,
     ALWAYS
   } _internal_solve_output_on;

◆ SolveState

enum SingleVariableReturnMappingSolution::SolveState

strongprivate

Enumerator
SUCCESS
NAN_INF
EXCEEDED_ITERATIONS

Definition at line 137 of file SingleVariableReturnMappingSolution.h.

   {
     SUCCESS,
     NAN_INF,
     EXCEEDED_ITERATIONS
   };

Constructor & Destructor Documentation

◆ SingleVariableReturnMappingSolution()

SingleVariableReturnMappingSolution::SingleVariableReturnMappingSolution ( const InputParameters & parameters )

Definition at line 59 of file SingleVariableReturnMappingSolution.C.

   : _check_range(false),
     _line_search(true),
     _bracket_solution(true),
     _internal_solve_output_on(
         parameters.get<MooseEnum>("internal_solve_output_on").getEnum<InternalSolveOutput>()),
     _max_its(1000), // Far larger than ever expected to be needed
     _internal_solve_full_iteration_history(
         parameters.get<bool>("internal_solve_full_iteration_history")),
     _relative_tolerance(parameters.get<Real>("relative_tolerance")),
     _absolute_tolerance(parameters.get<Real>("absolute_tolerance")),
     _acceptable_multiplier(parameters.get<Real>("acceptable_multiplier")),
     _num_resids(30),
     _residual_history(_num_resids, std::numeric_limits<Real>::max()),
     _iteration(0),
     _initial_residual(0.0),
     _residual(0.0),
     _svrms_name(parameters.get<std::string>("_object_name"))
 {
 }

◆ ~SingleVariableReturnMappingSolution()

virtual SingleVariableReturnMappingSolution::~SingleVariableReturnMappingSolution ( )

inlinevirtual

Definition at line 30 of file SingleVariableReturnMappingSolution.h.

30 {}

Member Function Documentation

◆ checkPermissibleRange()

void SingleVariableReturnMappingSolution::checkPermissibleRange	(	Real &	scalar,
		Real &	scalar_increment,
		const Real	scalar_old,
		const Real	min_permissible_scalar,
		const Real	max_permissible_scalar,
		std::stringstream *	iter_output
	)

private

Check to see whether solution is within admissible range, and set it within that range if it is not.

Parameters

scalar	Current value of the inelastic strain increment
scalar_increment	Incremental change in scalar from the previous iteration
scalar_old	Previous value of scalar
min_permissible_scalar	Minimum permissible value of scalar
max_permissible_scalar	Maximum permissible value of scalar
iter_output	Output stream

Definition at line 356 of file SingleVariableReturnMappingSolution.C.

 {
   if (scalar > max_permissible_scalar)
   {
     scalar_increment = (max_permissible_scalar - scalar_old) / 2.0;
     scalar = scalar_old + scalar_increment;
     if (iter_output)
       *iter_output << "Scalar greater than maximum (" << max_permissible_scalar
                    << ") adjusted scalar=" << scalar << " scalar_increment=" << scalar_increment
                    << std::endl;
   }
   else if (scalar < min_permissible_scalar)
   {
     scalar_increment = (min_permissible_scalar - scalar_old) / 2.0;
     scalar = scalar_old + scalar_increment;
     if (iter_output)
       *iter_output << "Scalar less than minimum (" << min_permissible_scalar
                    << ") adjusted scalar=" << scalar << " scalar_increment=" << scalar_increment
                    << std::endl;
   }
 }

Referenced by internalSolve().

◆ computeDerivative()

virtual Real SingleVariableReturnMappingSolution::computeDerivative	(	const Real	effective_trial_stress,
		const Real	scalar
	)

protectedpure virtual

Compute the derivative of the residual as a function of the scalar variable.

The residual should be in strain increment units for all models for consistency.

Parameters

effective_trial_stress	Effective trial stress
scalar	Inelastic strain increment magnitude being solved for

Implemented in IsotropicPlasticity, CLSHPlasticModel, PowerLawCreepModel, IsotropicPlasticityStressUpdate, PowerLawCreepStressUpdate, and PowerLawCreepExceptionTest.

Referenced by RadialReturnCreepStressUpdateBase::computeStressDerivative(), and internalSolve().

◆ computeReferenceResidual()

virtual Real SingleVariableReturnMappingSolution::computeReferenceResidual	(	const Real	effective_trial_stress,
		const Real	scalar
	)

protectedpure virtual

Compute a reference quantity to be used for checking relative convergence.

This should be in strain increment units for all models for consistency.

Parameters

effective_trial_stress	Effective trial stress
scalar	Inelastic strain increment magnitude being solved for

Implemented in RadialReturnStressUpdate, and ReturnMappingModel.

Referenced by internalSolve().

◆ computeResidual()

virtual Real SingleVariableReturnMappingSolution::computeResidual	(	const Real	effective_trial_stress,
		const Real	scalar
	)

protectedpure virtual

Compute the residual for a predicted value of the scalar.

This residual should be in strain increment units for all models for consistency.

Parameters

effective_trial_stress	Effective trial stress
scalar	Inelastic strain increment magnitude being solved for

Implemented in IsotropicPlasticity, CLSHPlasticModel, PowerLawCreepModel, IsotropicPlasticityStressUpdate, PowerLawCreepStressUpdate, and PowerLawCreepExceptionTest.

Referenced by internalSolve().

◆ converged()

bool SingleVariableReturnMappingSolution::converged	(	const Real	residual,
		const Real	reference
	)

private

Check to see whether the residual is within the convergence limits.

Parameters

residual	Current value of the residual
reference	Current value of the reference quantity

Returns: Whether the model converged

Definition at line 298 of file SingleVariableReturnMappingSolution.C.

 {
   return (std::abs(residual) <= _absolute_tolerance ||
           std::abs(residual / reference) <= _relative_tolerance);
 }

Referenced by convergedAcceptable(), and internalSolve().

◆ convergedAcceptable()

bool SingleVariableReturnMappingSolution::convergedAcceptable	(	const unsigned int	it,
		const Real	residual,
		const Real	reference
	)

private

Check to see whether the residual is within acceptable convergence limits.

This will only return true if it has been determined that progress is no longer being made and that the residual is within the acceptable limits.

Parameters

residual	Current iteration count
residual	Current value of the residual
reference	Current value of the reference quantity

Returns: Whether the model converged

Definition at line 305 of file SingleVariableReturnMappingSolution.C.

 {
   // Require that we have at least done _num_resids evaluations before we allow for
   // acceptable convergence
   if (it < _num_resids)
     return false;
  
   // Check to see whether the residual has dropped by convergence_history_factor over
   // the last _num_resids iterations. If it has (which means it's still making progress),
   // don't consider it to be converged within the acceptable limits.
   const Real convergence_history_factor = 10.0;
   if (std::abs(residual * convergence_history_factor) <
       std::abs(_residual_history[(it + 1) % _num_resids]))
     return false;
  
   // Now that it's determined that progress is not being made, treat it as converged if
   // we're within the acceptable convergence limits
   return converged(residual / _acceptable_multiplier, reference);
 }

Referenced by internalSolve().

◆ initialGuess()

virtual Real SingleVariableReturnMappingSolution::initialGuess ( const Real )

inlineprotectedvirtual

Compute an initial guess for the value of the scalar.

For some cases, an intellegent starting point can provide enhanced robustness in the Newton iterations. This is also an opportunity for classes that derive from this to perform initialization tasks.

Parameters

effective_trial_stress Effective trial stress

Definition at line 64 of file SingleVariableReturnMappingSolution.h.

64 { return 0.0; }

Referenced by internalSolve().

◆ internalSolve()

SingleVariableReturnMappingSolution::SolveState SingleVariableReturnMappingSolution::internalSolve	(	const Real	effective_trial_stress,
		Real &	scalar,
		std::stringstream *	iter_output = `nullptr`
	)

private

Method called from within this class to perform the actual return mappping iterations.

Parameters

effective_trial_stress	Effective trial stress
scalar	Inelastic strain increment magnitude being solved for
iter_output	Output stream – if null, no output is produced

Returns: Whether the solution was successful

Definition at line 157 of file SingleVariableReturnMappingSolution.C.

 {
   scalar = initialGuess(effective_trial_stress);
   Real scalar_old = scalar;
   Real scalar_increment = 0.0;
   const Real min_permissible_scalar = minimumPermissibleValue(effective_trial_stress);
   const Real max_permissible_scalar = maximumPermissibleValue(effective_trial_stress);
   Real scalar_upper_bound = max_permissible_scalar;
   Real scalar_lower_bound = min_permissible_scalar;
   _iteration = 0;
  
   _initial_residual = _residual = computeResidual(effective_trial_stress, scalar);
  
   Real residual_old = _residual;
   Real init_resid_sign = MathUtils::sign(_residual);
   Real reference_residual = computeReferenceResidual(effective_trial_stress, scalar);
  
   if (converged(_residual, reference_residual))
   {
     iterationFinalize(scalar);
     outputIterationStep(
         iter_output, _iteration, effective_trial_stress, scalar, _residual, reference_residual);
     return SolveState::SUCCESS;
   }
  
   _residual_history.assign(_num_resids, std::numeric_limits<Real>::max());
   _residual_history[0] = _residual;
  
   while (_iteration < _max_its && !converged(_residual, reference_residual) &&
          !convergedAcceptable(_iteration, _residual, reference_residual))
   {
     scalar_increment = -_residual / computeDerivative(effective_trial_stress, scalar);
     scalar = scalar_old + scalar_increment;
  
     if (_check_range)
       checkPermissibleRange(scalar,
                             scalar_increment,
                             scalar_old,
                             min_permissible_scalar,
                             max_permissible_scalar,
                             iter_output);
  
     _residual = computeResidual(effective_trial_stress, scalar);
     reference_residual = computeReferenceResidual(effective_trial_stress, scalar);
     iterationFinalize(scalar);
  
     if (_bracket_solution)
       updateBounds(
           scalar, _residual, init_resid_sign, scalar_upper_bound, scalar_lower_bound, iter_output);
  
     if (converged(_residual, reference_residual))
     {
       outputIterationStep(
           iter_output, _iteration, effective_trial_stress, scalar, _residual, reference_residual);
       break;
     }
     else
     {
       bool modified_increment = false;
  
       // Line Search
       if (_line_search)
       {
         if (residual_old - _residual != 0.0)
         {
           Real alpha = residual_old / (residual_old - _residual);
           alpha = MathUtils::clamp(alpha, 1.0e-2, 1.0);
  
           if (alpha != 1.0)
           {
             modified_increment = true;
             scalar_increment *= alpha;
             if (iter_output)
               *iter_output << "  Line search alpha = " << alpha
                            << " increment = " << scalar_increment << std::endl;
           }
         }
       }
  
       if (_bracket_solution)
       {
         // Check to see whether trial scalar_increment is outside the bounds, and set it to a point
         // within the bounds if it is
         if (scalar_old + scalar_increment >= scalar_upper_bound ||
             scalar_old + scalar_increment <= scalar_lower_bound)
         {
           if (scalar_upper_bound != max_permissible_scalar &&
               scalar_lower_bound != min_permissible_scalar)
           {
             const Real frac = 0.5;
             scalar_increment =
                 (1.0 - frac) * scalar_lower_bound + frac * scalar_upper_bound - scalar_old;
             modified_increment = true;
             if (iter_output)
               *iter_output << "  Trial scalar_increment exceeded bounds.  Setting between "
                               "lower/upper bounds. frac: "
                            << frac << std::endl;
           }
         }
       }
  
       // Update the trial scalar and recompute residual if the line search or bounds checking
       // modified the increment
       if (modified_increment)
       {
         scalar = scalar_old + scalar_increment;
         _residual = computeResidual(effective_trial_stress, scalar);
         reference_residual = computeReferenceResidual(effective_trial_stress, scalar);
         iterationFinalize(scalar);
  
         if (_bracket_solution)
           updateBounds(scalar,
                        _residual,
                        init_resid_sign,
                        scalar_upper_bound,
                        scalar_lower_bound,
                        iter_output);
       }
     }
  
     outputIterationStep(
         iter_output, _iteration, effective_trial_stress, scalar, _residual, reference_residual);
  
     ++_iteration;
     residual_old = _residual;
     scalar_old = scalar;
     _residual_history[_iteration % _num_resids] = _residual;
   }
  
   if (std::isnan(_residual) || std::isinf(_residual))
     return SolveState::NAN_INF;
  
   if (_iteration == _max_its)
     return SolveState::EXCEEDED_ITERATIONS;
  
   return SolveState::SUCCESS;
 }

Referenced by returnMappingSolve().

◆ iterationFinalize()

virtual void SingleVariableReturnMappingSolution::iterationFinalize ( Real )

inlineprotectedvirtual

Finalize internal state variables for a model for a given iteration.

Parameters

scalar Inelastic strain increment magnitude being solved for

Reimplemented in IsotropicPlasticityStressUpdate, IsotropicPlasticity, and CLSHPlasticModel.

Definition at line 94 of file SingleVariableReturnMappingSolution.h.

94 {}

Referenced by internalSolve().

◆ maximumPermissibleValue()

Real SingleVariableReturnMappingSolution::maximumPermissibleValue ( const Real effective_trial_stress ) const

protectedvirtual

Compute the maximum permissible value of the scalar.

For some models, the magnitude of this may be known.

Parameters

effective_trial_stress Effective trial stress

Reimplemented in RadialReturnStressUpdate.

Definition at line 89 of file SingleVariableReturnMappingSolution.C.

 {
   return std::numeric_limits<Real>::max();
 }

Referenced by internalSolve().

◆ minimumPermissibleValue()

Real SingleVariableReturnMappingSolution::minimumPermissibleValue ( const Real effective_trial_stress ) const

protectedvirtual

Compute the minimum permissible value of the scalar.

For some models, the magnitude of this may be known.

Parameters

effective_trial_stress Effective trial stress

Reimplemented in ReturnMappingModel, and RadialReturnStressUpdate.

Definition at line 82 of file SingleVariableReturnMappingSolution.C.

 {
   return std::numeric_limits<Real>::lowest();
 }

Referenced by internalSolve().

◆ outputIterationStep()

void SingleVariableReturnMappingSolution::outputIterationStep	(	std::stringstream *	iter_output,
		const unsigned int	it,
		const Real	effective_trial_stress,
		const Real	scalar,
		const Real	residual,
		const Real	reference_residual
	)

protectedvirtual

Output information for a single iteration step to build the convergence history of the model.

Parameters

iter_output	Output stream
it	Current iteration count
effective_trial_stress	Effective trial stress
scalar	Inelastic strain increment magnitude being solved for
residual	Current value of the residual
reference	Current value of the reference quantity

Definition at line 328 of file SingleVariableReturnMappingSolution.C.

 {
   if (iter_output)
   {
     *iter_output << " iteration=" << it << " trial_stress=" << effective_trial_stress
                  << " scalar=" << scalar << " residual=" << residual
                  << " ref_res=" << reference_residual
                  << " rel_res=" << std::abs(residual) / reference_residual
                  << " rel_tol=" << _relative_tolerance << " abs_res=" << std::abs(residual)
                  << " abs_tol=" << _absolute_tolerance << '\n';
   }
 }

Referenced by internalSolve().

◆ outputIterationSummary()

void SingleVariableReturnMappingSolution::outputIterationSummary	(	std::stringstream *	iter_output,
		const unsigned int	total_it
	)

protectedvirtual

Output summary information for the convergence history of the model.

Parameters

iter_output	Output stream
total_it	Total iteration count

Reimplemented in RadialReturnStressUpdate, and ReturnMappingModel.

Definition at line 347 of file SingleVariableReturnMappingSolution.C.

 {
   if (iter_output)
     *iter_output << "In " << total_it << " iterations the residual went from " << _initial_residual
                  << " to " << _residual << " in '" << _svrms_name << "'.\n";
 }

Referenced by ReturnMappingModel::outputIterationSummary(), RadialReturnStressUpdate::outputIterationSummary(), and returnMappingSolve().

◆ returnMappingSolve()

void SingleVariableReturnMappingSolution::returnMappingSolve	(	const Real	effective_trial_stress,
		Real &	scalar,
		const ConsoleStream &	console
	)

protected

Perform the return mapping iterations.

Parameters

effective_trial_stress	Effective trial stress
scalar	Inelastic strain increment magnitude being solved for
console	Console output

Definition at line 96 of file SingleVariableReturnMappingSolution.C.

 {
   // construct the stringstream here only if the debug level is set to ALL
   std::unique_ptr<std::stringstream> iter_output =
       (_internal_solve_output_on == InternalSolveOutput::ALWAYS)
           ? libmesh_make_unique<std::stringstream>()
           : nullptr;
  
   // do the internal solve and capture iteration info during the first round
   // iff full history output is requested regardless of whether the solve failed or succeeded
   auto solve_state =
       internalSolve(effective_trial_stress,
                     scalar,
                     _internal_solve_full_iteration_history ? iter_output.get() : nullptr);
   if (solve_state != SolveState::SUCCESS &&
       _internal_solve_output_on != InternalSolveOutput::ALWAYS)
   {
     // output suppressed by user, throw immediately
     if (_internal_solve_output_on == InternalSolveOutput::NEVER)
       throw MooseException("");
  
     // user expects some kind of output, if necessary setup output stream now
     if (!iter_output)
       iter_output = libmesh_make_unique<std::stringstream>();
  
     // add the appropriate error message to the output
     switch (solve_state)
     {
       case SolveState::NAN_INF:
         *iter_output << "Encountered inf or nan in material return mapping iterations.\n";
         break;
  
       case SolveState::EXCEEDED_ITERATIONS:
         *iter_output << "Exceeded maximum iterations in material return mapping iterations.\n";
         break;
  
       default:
         mooseError("Unhandled solver state");
     }
  
     // if full history output is only requested for failed solves we have to repeat
     // the solve a second time
     if (_internal_solve_full_iteration_history)
       internalSolve(effective_trial_stress, scalar, iter_output.get());
  
     // Append summary and throw exception
     outputIterationSummary(iter_output.get(), _iteration);
     throw MooseException(iter_output->str());
   }
  
   if (_internal_solve_output_on == InternalSolveOutput::ALWAYS)
   {
     // the solve did not fail but the user requested debug output anyways
     outputIterationSummary(iter_output.get(), _iteration);
     console << iter_output->str();
   }
 }

Referenced by ReturnMappingModel::computeStress(), and RadialReturnStressUpdate::updateState().

◆ updateBounds()

void SingleVariableReturnMappingSolution::updateBounds	(	const Real	scalar,
		const Real	residual,
		const Real	init_resid_sign,
		Real &	scalar_upper_bound,
		Real &	scalar_lower_bound,
		std::stringstream *	iter_output
	)

private

Update the upper and lower bounds of the root for the effective inelastic strain.

Parameters

scalar	Current value of the inelastic strain increment
residual	Current value of the residual
init_resid_sign	Sign of the initial value of the residual
scalar_upper_bound	Upper bound value of scalar
scalar_lower_bound	Lower bound value of scalar
iter_output	Output stream

Definition at line 384 of file SingleVariableReturnMappingSolution.C.

 {
   // Update upper/lower bounds as applicable
   if (residual * init_resid_sign < 0.0 && scalar < scalar_upper_bound)
   {
     scalar_upper_bound = scalar;
     if (scalar_upper_bound < scalar_lower_bound)
     {
       scalar_upper_bound = scalar_lower_bound;
       scalar_lower_bound = 0.0;
       if (iter_output)
         *iter_output << "  Corrected for scalar_upper_bound < scalar_lower_bound" << std::endl;
     }
   }
   // Don't permit setting scalar_lower_bound > scalar_upper_bound (but do permit the reverse).
   // This ensures that if we encounter multiple roots, we pick the lowest one.
   else if (residual * init_resid_sign > 0.0 && scalar > scalar_lower_bound &&
            scalar < scalar_upper_bound)
     scalar_lower_bound = scalar;
 }

Referenced by internalSolve().

◆ validParams()

InputParameters SingleVariableReturnMappingSolution::validParams ( )

static

Definition at line 28 of file SingleVariableReturnMappingSolution.C.

 {
   InputParameters params = emptyInputParameters();
  
   // Newton iteration control parameters
   params.addParam<Real>(
       "relative_tolerance", 1e-8, "Relative convergence tolerance for Newton iteration");
   params.addParam<Real>(
       "absolute_tolerance", 1e-11, "Absolute convergence tolerance for Newton iteration");
   params.addParam<Real>("acceptable_multiplier",
                         10,
                         "Factor applied to relative and absolute "
                         "tolerance for acceptable convergence if "
                         "iterations are no longer making progress");
  
   // diagnostic output parameters
   MooseEnum internal_solve_output_on_enum("never on_error always", "on_error");
   params.addParam<MooseEnum>("internal_solve_output_on",
                              internal_solve_output_on_enum,
                              "When to output internal Newton solve information");
   params.addParam<bool>("internal_solve_full_iteration_history",
                         false,
                         "Set true to output full internal Newton iteration history at times "
                         "determined by `internal_solve_output_on`. If false, only a summary is "
                         "output.");
   params.addParamNamesToGroup("internal_solve_output_on internal_solve_full_iteration_history",
                               "Debug");
  
   return params;
 }

Referenced by RadialReturnStressUpdate::validParams().

Member Data Documentation

◆ _absolute_tolerance

Real SingleVariableReturnMappingSolution::_absolute_tolerance

private

Absolute convergence tolerance.

Definition at line 155 of file SingleVariableReturnMappingSolution.h.

Referenced by converged(), and outputIterationStep().

◆ _acceptable_multiplier

Real SingleVariableReturnMappingSolution::_acceptable_multiplier

private

Multiplier applied to relative and absolute tolerances for acceptable convergence.

Definition at line 158 of file SingleVariableReturnMappingSolution.h.

Referenced by convergedAcceptable().

◆ _bracket_solution

bool SingleVariableReturnMappingSolution::_bracket_solution

protected

Whether to save upper and lower bounds of root for scalar, and set solution to the midpoint between those bounds if outside them.

Definition at line 127 of file SingleVariableReturnMappingSolution.h.

Referenced by internalSolve().

◆ _check_range

bool SingleVariableReturnMappingSolution::_check_range

protected

Whether to check to see whether iterative solution is within admissible range, and set within that range if outside.

Definition at line 120 of file SingleVariableReturnMappingSolution.h.

Referenced by internalSolve().

◆ _initial_residual

Real SingleVariableReturnMappingSolution::_initial_residual

private

Residual values, kept as members to retain solver state for summary outputting.

Definition at line 170 of file SingleVariableReturnMappingSolution.h.

Referenced by internalSolve(), and outputIterationSummary().

◆ _internal_solve_full_iteration_history

const bool SingleVariableReturnMappingSolution::_internal_solve_full_iteration_history

private

Whether to output iteration information all the time (regardless of whether iterations converge)

Definition at line 149 of file SingleVariableReturnMappingSolution.h.

Referenced by returnMappingSolve().

◆ _internal_solve_output_on

enum SingleVariableReturnMappingSolution::InternalSolveOutput SingleVariableReturnMappingSolution::_internal_solve_output_on

private

Referenced by returnMappingSolve().

◆ _iteration

unsigned int SingleVariableReturnMappingSolution::_iteration

private

iteration number

Definition at line 167 of file SingleVariableReturnMappingSolution.h.

Referenced by internalSolve(), and returnMappingSolve().

◆ _line_search

bool SingleVariableReturnMappingSolution::_line_search

protected

Whether to use line searches to improve convergence.

Definition at line 123 of file SingleVariableReturnMappingSolution.h.

Referenced by internalSolve().

◆ _max_its

const unsigned int SingleVariableReturnMappingSolution::_max_its

private

Maximum number of return mapping iterations.

This exists only to avoid an infinite loop, and is is intended to be a large number that is not settable by the user.

Definition at line 146 of file SingleVariableReturnMappingSolution.h.

Referenced by internalSolve().

◆ _num_resids

const std::size_t SingleVariableReturnMappingSolution::_num_resids

private

Number of residuals to be stored in history.

Definition at line 161 of file SingleVariableReturnMappingSolution.h.

Referenced by convergedAcceptable(), and internalSolve().

◆ _relative_tolerance

Real SingleVariableReturnMappingSolution::_relative_tolerance

private

Relative convergence tolerance.

Definition at line 152 of file SingleVariableReturnMappingSolution.h.

Referenced by converged(), and outputIterationStep().

◆ _residual

Real SingleVariableReturnMappingSolution::_residual

private

Definition at line 171 of file SingleVariableReturnMappingSolution.h.

Referenced by internalSolve(), and outputIterationSummary().

◆ _residual_history

std::vector<Real> SingleVariableReturnMappingSolution::_residual_history

private

History of residuals used to check whether progress is still being made on decreasing the residual.

Definition at line 164 of file SingleVariableReturnMappingSolution.h.

Referenced by convergedAcceptable(), and internalSolve().

◆ _svrms_name

const std::string SingleVariableReturnMappingSolution::_svrms_name

private

MOOSE input name of the object performing the solve.

Definition at line 175 of file SingleVariableReturnMappingSolution.h.

Referenced by outputIterationSummary().

The documentation for this class was generated from the following files:

tensor_mechanics/include/materials/SingleVariableReturnMappingSolution.h
tensor_mechanics/src/materials/SingleVariableReturnMappingSolution.C

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ InternalSolveOutput

◆ SolveState

Constructor & Destructor Documentation

◆ SingleVariableReturnMappingSolution()

◆ ~SingleVariableReturnMappingSolution()

Member Function Documentation

◆ checkPermissibleRange()

◆ computeDerivative()

◆ computeReferenceResidual()

◆ computeResidual()

◆ converged()

◆ convergedAcceptable()

◆ initialGuess()

◆ internalSolve()

◆ iterationFinalize()

◆ maximumPermissibleValue()

◆ minimumPermissibleValue()

◆ outputIterationStep()

◆ outputIterationSummary()

◆ returnMappingSolve()

◆ updateBounds()

◆ validParams()

Member Data Documentation

◆ _absolute_tolerance

◆ _acceptable_multiplier

◆ _bracket_solution

◆ _check_range

◆ _initial_residual

◆ _internal_solve_full_iteration_history

◆ _internal_solve_output_on

◆ _iteration

◆ _line_search

◆ _max_its

◆ _num_resids

◆ _relative_tolerance

◆ _residual

◆ _residual_history

◆ _svrms_name