CriticalitySearchBase.h

Go to the documentation of this file.

/********************************************************************/
/*                  SOFTWARE COPYRIGHT NOTIFICATION                 */
/*                             Cardinal                             */
/*                                                                  */
/*                  (c) 2021 UChicago Argonne, LLC                  */
/*                        ALL RIGHTS RESERVED                       */
/*                                                                  */
/*                 Prepared by UChicago Argonne, LLC                */
/*               Under Contract No. DE-AC02-06CH11357               */
/*                With the U. S. Department of Energy               */
/*                                                                  */
/*             Prepared by Battelle Energy Alliance, LLC            */
/*               Under Contract No. DE-AC07-05ID14517               */
/*                With the U. S. Department of Energy               */
/*                                                                  */
/*                 See LICENSE for full restrictions                */
/********************************************************************/

#pragma once

#include "MooseObject.h"
#include "OpenMCBase.h"
#include "CardinalEnums.h"

class CriticalitySearchBase : public MooseObject, public OpenMCBase
{
public:
  static InputParameters validParams();

  CriticalitySearchBase(const InputParameters & parameters);

  virtual void updateOpenMCModel(const Real & input) = 0;

  virtual void searchForCriticality(std::function<void()> step_callback);

  virtual bool changingGeometry() const = 0;

protected:
  virtual std::string quantity() const = 0;

  virtual std::string units() const = 0;

  const Real & _maximum;

  const Real & _minimum;

  const Real & _k_tol;

  const Real & _root_tol;

  const eigenvalue::EigenvalueEnum _estimator;

  const bool & _run_critical_state;

  const bool & _tally_during_search;

  const Real & _target;

  std::vector<Real> _inputs;

  std::vector<Real> _k_values;

  std::vector<Real> _k_std_dev_values;

  const std::string _pp_name = "critical_value";
};