InversionControlBase.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 "Control.h"
 
#include <optional>
 
class Function;
 
class InversionControlBase : public Control
{
public:
  static InputParameters validParams();
 
  InversionControlBase(const InputParameters & parameters);
 
  virtual void execute() override final;
 
protected:
  struct IterationUpdate
  {
    Real next_parameter;
    Real residual;
    bool publish;
  };
 
  virtual IterationUpdate computeUpdate(unsigned int it, Real p_used, Real y, Real y_target) = 0;
 
  unsigned int fixedPointIteration() const;
 
  Real targetValue() const;
 
  void publishConvergedParameter(Real p);
 
  void setParameter(Real p);
 
  Real linearRootUpdate(Real p_a, Real y_a, Real p_b, Real y_b, Real y_target);
 
  Real normalizedResidual(Real y) const;
 
  void setResidual(Real value);
 
  const PostprocessorValue & _output;
  const PostprocessorValue & _param;
  const PostprocessorName _param_name;
  const std::optional<PostprocessorName> _converged_param_name;
  const Function & _target_function;
  const PostprocessorName _residual_name;
  const Real _abs_tol;
  const Real _rel_tol;
};