summaryrefslogtreecommitdiff
path: root/Yacs++/src/THM.hxx
blob: a2d7752c759028ad6ddce91050d1435fddc7f117 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
/**
 * This class is a C++ wrapper for a while loop calling a
 * Cle-2000 procedure named THMComponent.c2m at each iteration.
 * <P>
 *
 * @author Alain Hebert, Ecole Polytechnique de Montreal (2013)
 */
#ifndef __THM_HXX__
#define __THM_HXX__

#include "Cle2000.hxx"
#include "Communication.hxx"

class THM {
public:
  /** use this constructor to create a new THM object
   */
  THM();

  /** use this method to assign a Calcium component to the THM object
   * @param component Calcium component reference
   */
  void initialize(void* component);

  /** use this method to execute the THM object
   */
  void run();

private:
  Communication communicator_;
}; // class THM

#endif