Transfer.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://www.mooseframework.org
//*
//* 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
#include "MooseObject.h"
#include "MooseTypes.h"
#include "SetupInterface.h"
#include "Restartable.h"
#include "PerfGraphInterface.h"

class SubProblem;
class FEProblemBase;
class FEProblem;
class SystemBase;

namespace libMesh
{
class System;
class EquationSystems;
}

class Transfer : public MooseObject,
                 public SetupInterface,
                 public Restartable,
                 public PerfGraphInterface
{
public:
  Transfer(const InputParameters & parameters);
  virtual ~Transfer() = default;

  static InputParameters validParams();

  virtual void execute() = 0;

  virtual void initialSetup() {}

  static System * find_sys(EquationSystems & es, const std::string & var_name);

  enum DIRECTION
  {
    TO_MULTIAPP,
    FROM_MULTIAPP,
    BETWEEN_MULTIAPP
  };

  static std::string possibleDirections() { return "to_multiapp from_multiapp between_multiapp"; }

  const MultiMooseEnum & directions() { return _directions; }

  MooseEnum direction() { return _direction; }
  MooseEnum currentDirection() { return _current_direction; }

  void setCurrentDirection(const int direction)
  {
    _current_direction = direction;
    _direction = direction;
  }

protected:
  SubProblem & _subproblem;
  FEProblemBase & _fe_problem;
  SystemBase & _sys;

  THREAD_ID _tid;

  MooseEnum _direction;
  MooseEnum _current_direction;

  MultiMooseEnum _directions;

public:
  const static Number OutOfMeshValue;
};