helics 3.7.0
Loading...
Searching...
No Matches
helicsTime.hpp
Go to the documentation of this file.
1/*
2Copyright (c) 2017-2026,
3Battelle Memorial Institute; Lawrence Livermore National Security, LLC; Alliance for Energy
4Innovation LLC. See the top-level NOTICE for additional details. All rights reserved.
5SPDX-License-Identifier: BSD-3-Clause
6*/
7#pragma once
8#ifndef HELICS_TIME_HEADER_
9# define HELICS_TIME_HEADER_
10# include "../utilities/timeRepresentation.hpp"
11# include "CoreTypes.hpp"
12# include "helics/helics-config.h"
13
14# include <cstdint>
18namespace helics {
24# ifdef HELICS_USE_PICOSECOND_TIME
25using Time = TimeRepresentation<count_time<12>>;
26# else
27using Time = TimeRepresentation<count_time<9>>;
28# endif
29
31constexpr Time timeZero = Time::zeroVal();
33constexpr Time timeEpsilon = Time::epsilon();
35constexpr Time negEpsilon = -Time::epsilon();
37constexpr Time cBigTime = Time{HELICS_BIG_NUMBER};
39constexpr Time cTerminationTime = Time{HELICS_TERMINATION_TIME_VALUE};
41constexpr Time cMaxTime = Time{HELICS_MAX_TIME_VALUE};
44
50
51} // namespace helics
52
53#endif // HELICS_TIME_HEADER_
the main namespace for the helics co-simulation library User functions will be in the helics namespac...
Definition AsyncFedCallInfo.hpp:14
constexpr Time cBigTime
Definition helicsTime.hpp:37
IterationResult
Definition CoreTypes.hpp:94
constexpr Time timeEpsilon
Definition helicsTime.hpp:33
constexpr Time timeZero
Definition helicsTime.hpp:31
constexpr Time cTerminationTime
Definition helicsTime.hpp:39
TimeRepresentation< count_time< 9 > > Time
Definition helicsTime.hpp:27
constexpr Time cMaxTime
Definition helicsTime.hpp:41
constexpr Time initializationTime
Definition helicsTime.hpp:43
constexpr Time negEpsilon
Definition helicsTime.hpp:35
Definition helicsTime.hpp:46
IterationResult state
the convergence state
Definition helicsTime.hpp:48
Time grantedTime
the time of the granted step
Definition helicsTime.hpp:47