www.mooseframework.org
Transfer.h
Go to the documentation of this file.
1 /****************************************************************/
2 /* DO NOT MODIFY THIS HEADER */
3 /* MOOSE - Multiphysics Object Oriented Simulation Environment */
4 /* */
5 /* (c) 2010 Battelle Energy Alliance, LLC */
6 /* ALL RIGHTS RESERVED */
7 /* */
8 /* Prepared by Battelle Energy Alliance, LLC */
9 /* Under Contract No. DE-AC07-05ID14517 */
10 /* With the U. S. Department of Energy */
11 /* */
12 /* See COPYRIGHT for full restrictions */
13 /****************************************************************/
14 
15 #ifndef TRANSFER_H
16 #define TRANSFER_H
17 
18 // Moose
19 #include "MooseObject.h"
20 #include "MooseTypes.h"
21 #include "SetupInterface.h"
22 #include "Restartable.h"
23 
24 // Forward declarations
25 class Transfer;
26 class SubProblem;
27 class FEProblemBase;
28 class FEProblem;
29 class SystemBase;
30 
31 namespace libMesh
32 {
33 class System;
34 class EquationSystems;
35 }
36 
37 template <>
39 
46 class Transfer : public MooseObject, public SetupInterface, public Restartable
47 {
48 public:
49  Transfer(const InputParameters & parameters);
50  virtual ~Transfer() = default;
51 
55  virtual void execute() = 0;
56 
61  virtual void initialSetup() {}
62 
71  static System * find_sys(EquationSystems & es, const std::string & var_name);
72 
73 protected:
77 
79 
80 public:
81  const static Number OutOfMeshValue;
82 };
83 
84 #endif /* TRANSFER_H */
A class for creating restricted objects.
Definition: Restartable.h:31
Specialization of SubProblem for solving nonlinear equations plus auxiliary equations.
Definition: FEProblem.h:30
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
FEProblemBase & _fe_problem
Definition: Transfer.h:75
The following methods are specializations for using the libMesh::Parallel::packed_range_* routines fo...
Base class for a system (of equations)
Definition: SystemBase.h:91
Specialization of SubProblem for solving nonlinear equations plus auxiliary equations.
InputParameters validParams< Transfer >()
Definition: Transfer.C:31
SystemBase & _sys
Definition: Transfer.h:76
Every object that can be built by the factory should be derived from this class.
Definition: MooseObject.h:36
virtual void initialSetup()
Method called at the beginning of the simulation for checking integrity or doing one-time setup...
Definition: Transfer.h:61
static const Number OutOfMeshValue
Definition: Transfer.h:81
THREAD_ID _tid
Definition: Transfer.h:78
SubProblem & _subproblem
Definition: Transfer.h:74
Generic class for solving transient nonlinear problems.
Definition: SubProblem.h:53
unsigned int THREAD_ID
Definition: MooseTypes.h:79
Base class for all Transfer objects.
Definition: Transfer.h:46