Scippy

UG

Ubiquity Generator framework

paraParamSetTh.h
Go to the documentation of this file.
1 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
2 /* */
3 /* This file is part of the program and software framework */
4 /* UG --- Ubquity Generator Framework */
5 /* */
6 /* Copyright Written by Yuji Shinano <shinano@zib.de>, */
7 /* Copyright (C) 2021 by Zuse Institute Berlin, */
8 /* licensed under LGPL version 3 or later. */
9 /* Commercial licenses are available through <licenses@zib.de> */
10 /* */
11 /* This code is free software; you can redistribute it and/or */
12 /* modify it under the terms of the GNU Lesser General Public License */
13 /* as published by the Free Software Foundation; either version 3 */
14 /* of the License, or (at your option) any later version. */
15 /* */
16 /* This program is distributed in the hope that it will be useful, */
17 /* but WITHOUT ANY WARRANTY; without even the implied warranty of */
18 /* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the */
19 /* GNU Lesser General Public License for more details. */
20 /* */
21 /* You should have received a copy of the GNU Lesser General Public License */
22 /* along with this program. If not, see <http://www.gnu.org/licenses/>. */
23 /* */
24 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
25 
26 /**@file paraParamSetTh.h
27  * @brief
28  * @author Yuji Shinano
29  *
30  *
31  *
32  */
33 
34 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
35 
36 
37 #ifndef __PARA_PARAM_SET_TH_H__
38 #define __PARA_PARAM_SET_TH_H__
39 #include "paraDef.h"
40 #include "paraParamSet.h"
41 
42 namespace UG
43 {
44 
45 ///
46 /// class ParaParamSetTh
47 ///
49 {
50 
51 public:
52 
53  ///
54  /// constructor
55  ///
57  )
58  {
59  }
60 
61  ///
62  /// constructor
63  ///
65  int inNParaParams
66  )
67  : ParaParamSet(inNParaParams)
68  {
69  }
70 
71  ///
72  /// destructor
73  ///
75  )
76  {
77  }
78 
79  ///
80  /// broadcast ParaParams
81  /// @return always 0 (for future extensions)
82  ///
83  int bcast(
84  ParaComm *comm, ///< communicator used
85  int root ///< root rank for broadcast
86  )
87  {
88  THROW_LOGICAL_ERROR1("bcast is called in ParaParamSetTh");
89  }
90 
91 };
92 
93 }
94 
95 #endif // __PARA_PARAM_SET_TH_H__
static ScipParaCommTh * comm
Definition: fscip.cpp:73
int bcast(ParaComm *comm, int root)
broadcast ParaParams
Defines for UG Framework.
~ParaParamSetTh()
destructor
ParaParamSetTh(int inNParaParams)
constructor
Parameter set for UG framework.
#define THROW_LOGICAL_ERROR1(msg1)
Definition: paraDef.h:52
class ParaParamSet
Definition: paraParamSet.h:850
class ParaParamSetTh
ParaParamSetTh()
constructor
Base class of communicator object.
Definition: paraComm.h:101