doxygen/moose/SecantSolve_8h_source.html

//* 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 "FixedPointSolve.h"

#include "NonlinearSystemBase.h"


class SecantSolve : public FixedPointSolve

{

public:

  SecantSolve(Executioner & ex);


  static InputParameters validParams();


  virtual void allocateStorage(const bool primary) override final;


  virtual void printFixedPointConvergenceHistory(

      Real initial_norm,

      const std::vector<Real> & timestep_begin_norms,

      const std::vector<Real> & timestep_end_norms) const override final;


private:

  virtual void saveVariableValues(const bool primary) override final;


  virtual void savePostprocessorValues(const bool primary) override final;


  virtual bool useFixedPointAlgorithmUpdateInsteadOfPicard(const bool primary) override final;


  virtual void transformPostprocessors(const bool primary) override final;


  virtual void transformVariables(const std::set<dof_id_type> & transformed_dofs,

                                  const bool primary) override final;


  TagID _fxn_m1_tagid = Moose::INVALID_TAG_ID;


  TagID _xn_m1_tagid = Moose::INVALID_TAG_ID;


  TagID _fxn_m2_tagid = Moose::INVALID_TAG_ID;


  TagID _xn_m2_tagid = Moose::INVALID_TAG_ID;


  TagID _secondary_fxn_m1_tagid = Moose::INVALID_TAG_ID;


  TagID _secondary_xn_m1_tagid = Moose::INVALID_TAG_ID;


  TagID _secondary_fxn_m2_tagid = Moose::INVALID_TAG_ID;


  TagID _secondary_xn_m2_tagid = Moose::INVALID_TAG_ID;

};


FixedPointSolve.h

TagID
unsigned int TagID
Definition MooseTypes.h:238

NonlinearSystemBase.h

Executioner
Executioners are objects that do the actual work of solving your problem.
Definition Executioner.h:37

FixedPointSolve
Definition FixedPointSolve.h:18

InputParameters
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system.
Definition InputParameters.h:68

SecantSolve
Definition SecantSolve.h:16

SecantSolve::savePostprocessorValues
virtual void savePostprocessorValues(const bool primary) override final
Saves the current values of the postprocessors, and update the old(er) vectors.
Definition SecantSolve.C:131

SecantSolve::_xn_m1_tagid
TagID _xn_m1_tagid
Vector tag id for the solution variable before the latest solve, as a main app.
Definition SecantSolve.h:88

SecantSolve::_secondary_xn_m1_tagid
TagID _secondary_xn_m1_tagid
Vector tag id for the solution variable before the latest solve, as a sub app.
Definition SecantSolve.h:100

SecantSolve::transformPostprocessors
virtual void transformPostprocessors(const bool primary) override final
Use the fixed point algorithm to transform the postprocessors.
Definition SecantSolve.C:181

SecantSolve::_xn_m2_tagid
TagID _xn_m2_tagid
Vector tag id for the solution variable two solves ago, as a main app.
Definition SecantSolve.h:94

SecantSolve::allocateStorage
virtual void allocateStorage(const bool primary) override final
Allocate storage for the fixed point algorithm.
Definition SecantSolve.C:37

SecantSolve::_secondary_fxn_m1_tagid
TagID _secondary_fxn_m1_tagid
Vector tag id for the most recent solution variable, pre-Secant transform, as a sub app.
Definition SecantSolve.h:97

SecantSolve::transformVariables
virtual void transformVariables(const std::set< dof_id_type > &transformed_dofs, const bool primary) override final
Use the fixed point algorithm to transform the variables.
Definition SecantSolve.C:227

SecantSolve::useFixedPointAlgorithmUpdateInsteadOfPicard
virtual bool useFixedPointAlgorithmUpdateInsteadOfPicard(const bool primary) override final
Use the fixed point algorithm transform instead of simply using the Picard update.
Definition SecantSolve.C:171

SecantSolve::_fxn_m1_tagid
TagID _fxn_m1_tagid
Vector tag id for the most recent solution variable, pre-Secant transform, as a main app.
Definition SecantSolve.h:85

SecantSolve::validParams
static InputParameters validParams()
Definition SecantSolve.C:19

SecantSolve::_secondary_xn_m2_tagid
TagID _secondary_xn_m2_tagid
Vector tag id for the solution variable two primary solves ago, as a sub app.
Definition SecantSolve.h:106

SecantSolve::_fxn_m2_tagid
TagID _fxn_m2_tagid
Vector tag id for the result of the last but one solve, as a main app.
Definition SecantSolve.h:91

SecantSolve::printFixedPointConvergenceHistory
virtual void printFixedPointConvergenceHistory(Real initial_norm, const std::vector< Real > &timestep_begin_norms, const std::vector< Real > &timestep_end_norms) const override final
Print the convergence history of the coupling, at every fixed point iteration.
Definition SecantSolve.C:278

SecantSolve::saveVariableValues
virtual void saveVariableValues(const bool primary) override final
Saves the current values of the variables, and update the old(er) vectors.
Definition SecantSolve.C:75

SecantSolve::_secondary_fxn_m2_tagid
TagID _secondary_fxn_m2_tagid
Vector tag id for the result of the last but one secondary solve, as a sub app.
Definition SecantSolve.h:103

Moose::INVALID_TAG_ID
const TagID INVALID_TAG_ID
Definition MooseTypes.C:23