Scippy

UG

Ubiquity Generator framework

scipParaDeterministicTimer.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 scipParaDeterministicTimer.h
27  * @brief ParaDeterministicTimer extension for SCIP.
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 __SCIP_PARA_DETERMINISITC_TIMER_H__
38 #define __SCIP_PARA_DETERMINISITC_TIMER_H__
39 
41 
42 namespace ParaSCIP
43 {
44 
46 {
47  double current;
49 public:
50  ScipParaDeterministicTimer() : current(0.0), normalizeFactor(1) {}
52  /**********************************************
53  * if you want to set original initial time, *
54  * you can do it init() *
55  **********************************************/
56  void normalize(UG::ParaComm *comm){ normalizeFactor = comm->getSize() - 1; }
57  void update(double value) { current += value; }
58  double getElapsedTime() { return current/normalizeFactor; }
59 };
60 
61 }
62 
63 #endif // __SCIP_PARA_DETERMINISTIC_TIMER_H__
static ScipParaCommTh * comm
Definition: fscip.cpp:73
Base class for deterministic timer.
class for deterministic timer
virtual int getSize()=0
get number of UG processes or UG threads depending on run-time environment
Base class of communicator object.
Definition: paraComm.h:101