TransientMultiApp.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 "MultiApp.h"
 
#include "libmesh/numeric_vector.h"
 
class TransientBase;
 
class TransientMultiApp : public MultiApp
{
public:
  static InputParameters validParams();
 
  TransientMultiApp(const InputParameters & parameters);
 
  virtual NumericVector<Number> & appTransferVector(unsigned int app,
                                                    std::string var_name) override;
 
  virtual void initialSetup() override;
 
  virtual bool solveStep(Real dt, Real target_time, bool auto_advance = true) override;
 
  virtual void incrementTStep(Real target_time) override;
 
  virtual void finishStep(bool recurse_through_multiapp_levels = false) override;
 
  virtual void resetApp(unsigned int global_app, Real time) override;
 
  Real computeDT();
 
private:
  void setupApp(unsigned int i, Real time = 0.0);
 
  std::vector<TransientBase *> _transient_executioners;
 
  bool _sub_cycling;
  bool _interpolate_transfers;
  bool _detect_steady_state;
  bool _output_sub_cycles;
 
  unsigned int _max_failures;
  bool _tolerate_failure;
 
  unsigned int _failures;
 
  bool _catch_up;
  Real _max_catch_up_steps;
 
  bool & _first;
 
  std::vector<std::string> _transferred_vars;
 
  std::set<dof_id_type> _transferred_dofs;
 
  std::vector<std::map<std::string, unsigned int>> _output_file_numbers;
 
  bool _auto_advance;
 
  std::set<unsigned int> _reset;
 
  bool _print_sub_cycles;
};
 
class MultiAppSolveFailure : public std::runtime_error
{
public:
  MultiAppSolveFailure(const std::string & error) throw() : runtime_error(error) {}
 
  MultiAppSolveFailure(const MultiAppSolveFailure & e) throw() : runtime_error(e) {}
 
  ~MultiAppSolveFailure() throw() {}
};