www.mooseframework.org
MultiAppFXTransfer.h
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://www.mooseframework.org
3 //*
4 //* All rights reserved, see COPYRIGHT for full restrictions
5 //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6 //*
7 //* Licensed under LGPL 2.1, please see LICENSE for details
8 //* https://www.gnu.org/licenses/lgpl-2.1.html
9 
10 #pragma once
11 
12 #include "MultiAppTransfer.h"
13 
15 
20 {
21 public:
23 
25 
26  // Overrides from MultiAppTransfer
27  virtual void execute() override;
28  virtual void initialSetup() override;
29 
30 protected:
32  const std::string _this_app_object_name;
33 
35  const std::string _multi_app_object_name;
36 
37 private:
42  const std::string & object_name,
43  THREAD_ID thread);
44 
49  const std::string & object_name,
50  THREAD_ID thread);
51 
57  FEProblemBase & base, const std::string & object_name, THREAD_ID thread);
58 
59 protected:
65  const std::string & object_name,
66  const std::string & app_name);
67 
70 
73 };
Transfers mutable coefficient arrays between supported object types.
MutableCoefficientsInterface &(MultiAppFXTransfer::* GetProblemObject)(FEProblemBase &base, const std::string &object_name, THREAD_ID thread)
Function pointer typedef for functions used to find, convert, and return the appropriate MutableCoeff...
static InputParameters validParams()
MutableCoefficientsInterface & getMutableCoefficientsUserOject(FEProblemBase &base, const std::string &object_name, THREAD_ID thread)
Gets a MutableCoefficientsInterface-based UserObject, intended for use via function pointer...
MultiAppFXTransfer(const InputParameters &parameters)
const std::string _this_app_object_name
Name of the MutableCoefficientsInterface-derived object in the creating app.
const std::string _multi_app_object_name
Name of the MutableCoefficientsInterface-derived object in the MultiApp.
MutableCoefficientsInterface & getMutableCoefficientsFunction(FEProblemBase &base, const std::string &object_name, THREAD_ID thread)
Gets a MutableCoefficientsInterface-based Function, intented for use via function pointer...
GetProblemObject getSubAppObject
Function pointer for grabbing the SubApp object.
virtual GetProblemObject scanProblemBaseForObject(FEProblemBase &base, const std::string &object_name, const std::string &app_name)
Searches an FEProblemBase for a MutableCoefficientsInterface-based object and returns a function poin...
virtual void execute() override
const InputParameters & parameters() const
This class is designed to provide a uniform interface for any class that uses an array of coefficient...
virtual void initialSetup() override
GetProblemObject getMultiAppObject
Function pointer for grabbing the MultiApp object.
unsigned int THREAD_ID