Coverage for physioblocks / configuration / constants.py: 100%

1# SPDX-FileCopyrightText: Copyright INRIA 

2# 

3# SPDX-License-Identifier: LGPL-3.0-only 

4# 

5# Copyright INRIA 

6# 

7# This file is part of PhysioBlocks, a library mostly developed by the 

8# [Ananke project-team](https://team.inria.fr/ananke) at INRIA. 

9# 

10# Authors: 

11# - Colin Drieu 

12# - Dominique Chapelle 

13# - François Kimmig 

14# - Philippe Moireau 

15# 

16# PhysioBlocks is free software: you can redistribute it and/or modify it under the 

17# terms of the GNU Lesser General Public License as published by the Free Software 

18# Foundation, version 3 of the License. 

19# 

20# PhysioBlocks is distributed in the hope that it will be useful, but WITHOUT ANY 

21# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A 

22# PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. 

23# 

24# You should have received a copy of the GNU Lesser General Public License along with 

25# PhysioBlocks. If not, see <https://www.gnu.org/licenses/>. 

26 

27# Simulation 

28 

29# Simulation item id in the configuration 

30SIMULATION_ID = "simulation" 

31 

32# Boundary conditions item id in the configuration. 

33BOUNDARIES_ID = "boundaries_conditions" 

34 

35# Parameters register id in the configuration 

36PARAMETERS_ID = "parameters" 

37 

38# Definition of the flux-dof types couples 

39FLUX_DOF_DEFINITION_ID = "flux_dof_definitions" 

40 

41 

42# Magnitudes 

43 

44# The variable magnitude item label in the configuration 

45MAGNITUDES = "magnitudes" 

46 

47# The variable magnitude item label in the configuration 

48VARIABLES_MAGNITUDES = "variables_magnitudes" 

49 

50# Nets 

51 

52# Net label id in the configuration 

53NET_ID = "net" 

54 

55# Label of the nodes item 

56NODES_ITEM_ID = "nodes" 

57 

58# Blocks 

59 

60# Label of the blocks item 

61BLOCKS_ITEM_ID = "blocks" 

62 

63# Label of the flux type component in block definition. 

64BLOCK_FLUX_TYPE_ITEM_ID = "flux_type" 

65 

66# Label of the submodels components item 

67SUBMODEL_ITEM_ID = "submodels" 

68 

69# Label of the model type item 

70MODEL_COMPONENT_TYPE_ITEM_ID = "model_type" 

71 

72 

73# Boundary Conditions 

74 

75# The id of the type of boundary condition field in the configuration 

76CONDITION_TYPE_ID = "condition_type" 

77 

78# The id of the name of boundary condition field in the configuration 

79CONDITION_NAME_ID = "condition_id" 

80 

81 

82# Solvers 

83 

84# The solver item label in the configuration 

85SOLVER_ID = "solver" 

86 

87# Solver tolerance config id constant 

88TOLERANCE_VAL_ID = "tolerance" 

89 

90# Solver maximum iteration config id constant 

91ITERATION_MAX_VAL_ID = "iteration_max" 

92 

93 

94# State 

95 

96# Id of the initialization values of the variables in the configuration 

97INIT_VARIABLES_ID = "variables_initialization" 

98 

99 

100# Time Manager 

101 

102# Time id in the configuration 

103TIME_MANAGER_ID = "time" 

104 

105# End time of the simulation id in the configuration 

106TIME_DURATION_TIME_VAL_ID = "duration" 

107 

108# Start time of the simulation id in the configuration 

109TIME_START_TIME_VAL_ID = "start" 

110 

111# Time step id in the configuration 

112TIME_STEP_TIME_VAL_ID = "step_size" 

113 

114# Minimum time step size id in the configuration 

115TIME_STEP_MIN_VAL_ID = "min_step" 

116 

117 

118# Outputs 

119 

120# Optional field id for output functions in the simulation configuration. 

121OUTPUTS_FUNCTIONS_ID = "output_functions"