SamplerFullSolveMultiApp.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

// MOOSE includes
#include "FullSolveMultiApp.h"
#include "SamplerInterface.h"

#include "StochasticToolsTypes.h"

class Sampler;
class StochasticToolsTransfer;

class SamplerFullSolveMultiApp : public FullSolveMultiApp,
                                 public SamplerInterface,
                                 public ReporterInterface
{
public:
  static InputParameters validParams();
  SamplerFullSolveMultiApp(const InputParameters & parameters);
  virtual bool solveStep(Real dt, Real target_time, bool auto_advance = true) override;
  virtual void preTransfer(Real dt, Real target_time) override;

  virtual void backup() override;

  static std::vector<std::string>
  sampledCommandLineArgs(const std::vector<Real> & row,
                         const std::vector<std::string> & full_args_name);

  static void
  execBatchTransfers(const std::vector<std::shared_ptr<StochasticToolsTransfer>> & transfers,
                     dof_id_type global_row_index,
                     const std::vector<Real> & row_data,
                     Transfer::DIRECTION direction,
                     bool verbose,
                     const ConsoleStream & console);

protected:
  virtual void showStatusMessage(unsigned int i) const override;

  Sampler & _sampler;

  const StochasticTools::MultiAppMode _mode;

  dof_id_type _local_batch_app_index;

  virtual std::vector<std::string> getCommandLineArgs(const unsigned int local_app) override;

private:
  bool solveStepBatch(Real dt, Real target_time, bool auto_advance = true);

  void updateRowData(dof_id_type local_index);

  std::vector<std::shared_ptr<StochasticToolsTransfer>>
  getActiveStochasticToolsTransfers(Transfer::DIRECTION direction);

  // Flag indicating a solve has occured
  bool _solved_once;

  // Sampler size, to test if the MultiApp object needs to be re-initialize
  dof_id_type _number_of_sampler_rows;

  std::vector<Real> _row_data;
  dof_id_type _local_row_index = std::numeric_limits<dof_id_type>::max();

  const std::vector<bool> * _should_run = nullptr;
};