luminarycloud 0.14.0__py3-none-any.whl → 0.15.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (295) hide show
  1. luminarycloud/__init__.py +8 -1
  2. luminarycloud/_client/client.py +9 -0
  3. luminarycloud/_client/logging_interceptor.py +25 -0
  4. luminarycloud/_client/tracing.py +13 -8
  5. luminarycloud/_helpers/__init__.py +2 -0
  6. luminarycloud/_helpers/_code_representation.py +135 -0
  7. luminarycloud/_helpers/_simulation_params_from_json.py +5 -1
  8. luminarycloud/_helpers/download.py +16 -0
  9. luminarycloud/_helpers/named_variables.py +25 -0
  10. luminarycloud/_helpers/upload.py +31 -11
  11. luminarycloud/_helpers/warnings/deprecated.py +8 -10
  12. luminarycloud/_helpers/warnings/experimental.py +4 -4
  13. luminarycloud/_proto/api/v0/luminarycloud/geometry/geometry_pb2.py +135 -110
  14. luminarycloud/_proto/api/v0/luminarycloud/geometry/geometry_pb2.pyi +82 -10
  15. luminarycloud/_proto/api/v0/luminarycloud/geometry/geometry_pb2_grpc.py +34 -0
  16. luminarycloud/_proto/api/v0/luminarycloud/geometry/geometry_pb2_grpc.pyi +12 -0
  17. luminarycloud/_proto/api/v0/luminarycloud/mesh/mesh_pb2.py +40 -40
  18. luminarycloud/_proto/api/v0/luminarycloud/mesh/mesh_pb2.pyi +8 -2
  19. luminarycloud/_proto/api/v0/luminarycloud/named_variable_set/named_variable_set_pb2.py +182 -0
  20. luminarycloud/_proto/api/v0/luminarycloud/named_variable_set/named_variable_set_pb2.pyi +260 -0
  21. luminarycloud/_proto/api/v0/luminarycloud/named_variable_set/named_variable_set_pb2_grpc.py +204 -0
  22. luminarycloud/_proto/api/v0/luminarycloud/named_variable_set/named_variable_set_pb2_grpc.pyi +75 -0
  23. luminarycloud/_proto/api/v0/luminarycloud/physics_ai/physics_ai_pb2.py +94 -0
  24. luminarycloud/_proto/api/v0/luminarycloud/physics_ai/physics_ai_pb2.pyi +145 -0
  25. luminarycloud/_proto/api/v0/luminarycloud/physics_ai/physics_ai_pb2_grpc.py +104 -0
  26. luminarycloud/_proto/api/v0/luminarycloud/physics_ai/physics_ai_pb2_grpc.pyi +42 -0
  27. luminarycloud/_proto/api/v0/luminarycloud/simulation_template/simulation_template_pb2.py +25 -25
  28. luminarycloud/_proto/api/v0/luminarycloud/simulation_template/simulation_template_pb2.pyi +10 -3
  29. luminarycloud/_proto/api/v0/luminarycloud/solution/solution_pb2.py +25 -3
  30. luminarycloud/_proto/api/v0/luminarycloud/solution/solution_pb2.pyi +32 -0
  31. luminarycloud/_proto/api/v0/luminarycloud/solution/solution_pb2_grpc.py +34 -0
  32. luminarycloud/_proto/api/v0/luminarycloud/solution/solution_pb2_grpc.pyi +12 -0
  33. luminarycloud/_proto/api/v0/luminarycloud/thirdpartyintegration/onshape/onshape_pb2.py +162 -0
  34. luminarycloud/_proto/api/v0/luminarycloud/thirdpartyintegration/onshape/onshape_pb2.pyi +254 -0
  35. luminarycloud/_proto/api/v0/luminarycloud/thirdpartyintegration/onshape/onshape_pb2_grpc.py +203 -0
  36. luminarycloud/_proto/api/v0/luminarycloud/thirdpartyintegration/onshape/onshape_pb2_grpc.pyi +74 -0
  37. luminarycloud/_proto/api/v0/luminarycloud/vis/vis_pb2.py +157 -141
  38. luminarycloud/_proto/api/v0/luminarycloud/vis/vis_pb2.pyi +32 -4
  39. luminarycloud/_proto/cad/boolean_pb2.py +8 -8
  40. luminarycloud/_proto/cad/boolean_pb2.pyi +34 -4
  41. luminarycloud/_proto/client/simulation_pb2.py +304 -294
  42. luminarycloud/_proto/client/simulation_pb2.pyi +30 -1
  43. luminarycloud/_proto/geometry/geometry_pb2.py +58 -58
  44. luminarycloud/_proto/geometry/geometry_pb2.pyi +58 -11
  45. luminarycloud/_proto/hexmesh/hexmesh_pb2.py +42 -42
  46. luminarycloud/_proto/hexmesh/hexmesh_pb2.pyi +2 -2
  47. luminarycloud/_proto/output/reference_values_pb2.py +5 -5
  48. luminarycloud/_proto/parametricworker/parametricworker_pb2.py +31 -31
  49. luminarycloud/_proto/parametricworker/parametricworker_pb2.pyi +6 -4
  50. luminarycloud/_proto/quantity/quantity_pb2.py +4 -4
  51. luminarycloud/_proto/table/table_pb2.py +9 -8
  52. luminarycloud/_proto/table/table_pb2.pyi +7 -1
  53. luminarycloud/enum/__init__.py +2 -0
  54. luminarycloud/enum/geometry_status.py +28 -0
  55. luminarycloud/geometry.py +64 -32
  56. luminarycloud/geometry_version.py +2 -2
  57. luminarycloud/mesh.py +11 -4
  58. luminarycloud/meshing/__init__.py +1 -0
  59. luminarycloud/meshing/metadata/__init__.py +6 -0
  60. luminarycloud/meshing/metadata/mesh_metadata.py +57 -0
  61. luminarycloud/named_variable_set.py +121 -0
  62. luminarycloud/outputs/output_definitions.py +11 -10
  63. luminarycloud/params/enum/_enum_wrappers.py +77 -968
  64. luminarycloud/params/outputs/output.py +2 -1
  65. luminarycloud/params/simulation/__init__.py +16 -16
  66. luminarycloud/params/simulation/_lib.py +1 -67
  67. luminarycloud/params/simulation/adaptive_mesh_refinement/boundary_layer_profile_.py +3 -2
  68. luminarycloud/params/simulation/adaptive_mesh_refinement_.py +3 -2
  69. luminarycloud/params/simulation/adjoint_.py +4 -3
  70. luminarycloud/params/simulation/basic/gravity/gravity_off_.py +3 -2
  71. luminarycloud/params/simulation/basic/gravity/gravity_on_.py +3 -2
  72. luminarycloud/params/simulation/basic/gravity_.py +3 -2
  73. luminarycloud/params/simulation/body_frame_.py +3 -2
  74. luminarycloud/params/simulation/entity_relationships/volume_material_relationship_.py +7 -6
  75. luminarycloud/params/simulation/entity_relationships/volume_physics_relationship_.py +7 -6
  76. luminarycloud/params/simulation/entity_relationships_.py +3 -2
  77. luminarycloud/params/simulation/general_.py +4 -3
  78. luminarycloud/params/simulation/material/fluid/__init__.py +4 -4
  79. luminarycloud/params/simulation/material/fluid/boussinesq_approximation/boussinesq_off_.py +3 -2
  80. luminarycloud/params/simulation/material/fluid/boussinesq_approximation/boussinesq_on_.py +3 -2
  81. luminarycloud/params/simulation/material/fluid/boussinesq_approximation_.py +3 -2
  82. luminarycloud/params/simulation/material/fluid/material_model/__init__.py +1 -1
  83. luminarycloud/params/simulation/material/fluid/material_model/ideal_gas_.py +3 -2
  84. luminarycloud/params/simulation/material/fluid/material_model/incompressible_fluid_.py +3 -2
  85. luminarycloud/params/simulation/material/fluid/material_model/incompressible_fluid_with_energy_.py +3 -2
  86. luminarycloud/params/simulation/material/fluid/material_model_.py +3 -2
  87. luminarycloud/params/simulation/material/fluid/thermal_conductivity_model/__init__.py +2 -2
  88. luminarycloud/params/simulation/material/fluid/thermal_conductivity_model/prescribed_conductivity_.py +3 -2
  89. luminarycloud/params/simulation/material/fluid/thermal_conductivity_model/prescribed_prandtl_number_.py +3 -2
  90. luminarycloud/params/simulation/material/fluid/thermal_conductivity_model/temperature_dependent_conductivity_.py +4 -3
  91. luminarycloud/params/simulation/material/fluid/thermal_conductivity_model_.py +3 -2
  92. luminarycloud/params/simulation/material/fluid/viscosity_model/__init__.py +1 -1
  93. luminarycloud/params/simulation/material/fluid/viscosity_model/prescribed_viscosity_.py +3 -2
  94. luminarycloud/params/simulation/material/fluid/viscosity_model/sutherland_.py +3 -2
  95. luminarycloud/params/simulation/material/fluid/viscosity_model/temperature_dependent_viscosity_.py +4 -3
  96. luminarycloud/params/simulation/material/fluid/viscosity_model_.py +3 -2
  97. luminarycloud/params/simulation/material/material_fluid_.py +7 -6
  98. luminarycloud/params/simulation/material/material_solid_.py +4 -3
  99. luminarycloud/params/simulation/material_entity_.py +9 -8
  100. luminarycloud/params/simulation/monitor_plane_.py +5 -4
  101. luminarycloud/params/simulation/motion_data/__init__.py +1 -1
  102. luminarycloud/params/simulation/motion_data/frame_transforms/__init__.py +1 -1
  103. luminarycloud/params/simulation/motion_data/frame_transforms/no_transform_.py +5 -4
  104. luminarycloud/params/simulation/motion_data/frame_transforms/rotational_transform_.py +5 -4
  105. luminarycloud/params/simulation/motion_data/frame_transforms/translational_transform_.py +5 -4
  106. luminarycloud/params/simulation/motion_data/frame_transforms_.py +3 -2
  107. luminarycloud/params/simulation/motion_data/motion_type/__init__.py +1 -1
  108. luminarycloud/params/simulation/motion_data/motion_type/constant_angular_motion_.py +5 -4
  109. luminarycloud/params/simulation/motion_data/motion_type/constant_translation_motion_.py +5 -4
  110. luminarycloud/params/simulation/motion_data/motion_type_.py +3 -2
  111. luminarycloud/params/simulation/motion_data_.py +6 -5
  112. luminarycloud/params/simulation/multi_physics_coupling_options_.py +3 -2
  113. luminarycloud/params/simulation/output_.py +3 -2
  114. luminarycloud/params/simulation/particle_group/particle_group_type/__init__.py +1 -1
  115. luminarycloud/params/simulation/particle_group/particle_group_type/actuator_disk/actuator_disk_orientation_selection/actuator_disk_specify_normal_vector_.py +4 -3
  116. luminarycloud/params/simulation/particle_group/particle_group_type/actuator_disk/actuator_disk_orientation_selection/actuator_disk_specify_rotation_angles_.py +4 -3
  117. luminarycloud/params/simulation/particle_group/particle_group_type/actuator_disk/actuator_disk_orientation_selection_.py +3 -2
  118. luminarycloud/params/simulation/particle_group/particle_group_type/actuator_disk_.py +7 -6
  119. luminarycloud/params/simulation/particle_group/particle_group_type/actuator_line_.py +3 -2
  120. luminarycloud/params/simulation/particle_group/particle_group_type/probe_points_.py +5 -4
  121. luminarycloud/params/simulation/particle_group/particle_group_type/source_points_.py +5 -4
  122. luminarycloud/params/simulation/particle_group/particle_group_type_.py +3 -2
  123. luminarycloud/params/simulation/particle_group_.py +4 -3
  124. luminarycloud/params/simulation/physics/__init__.py +3 -3
  125. luminarycloud/params/simulation/physics/fluid/__init__.py +9 -9
  126. luminarycloud/params/simulation/physics/fluid/adjoint_controls_fluid_.py +3 -2
  127. luminarycloud/params/simulation/physics/fluid/basic_fluid_.py +3 -2
  128. luminarycloud/params/simulation/physics/fluid/boundary_conditions/__init__.py +5 -5
  129. luminarycloud/params/simulation/physics/fluid/boundary_conditions/farfield_.py +5 -4
  130. luminarycloud/params/simulation/physics/fluid/boundary_conditions/inlet/__init__.py +3 -3
  131. luminarycloud/params/simulation/physics/fluid/boundary_conditions/inlet/fan_curve_inlet_.py +7 -6
  132. luminarycloud/params/simulation/physics/fluid/boundary_conditions/inlet/mach_inlet_.py +5 -4
  133. luminarycloud/params/simulation/physics/fluid/boundary_conditions/inlet/mass_flow_inlet_.py +5 -4
  134. luminarycloud/params/simulation/physics/fluid/boundary_conditions/inlet/total_pressure_inlet_.py +6 -5
  135. luminarycloud/params/simulation/physics/fluid/boundary_conditions/inlet/velocity_components_inlet_.py +5 -4
  136. luminarycloud/params/simulation/physics/fluid/boundary_conditions/inlet/velocity_magnitude_inlet_.py +6 -5
  137. luminarycloud/params/simulation/physics/fluid/boundary_conditions/inlet_.py +8 -7
  138. luminarycloud/params/simulation/physics/fluid/boundary_conditions/outlet/outlet_strategy/__init__.py +1 -1
  139. luminarycloud/params/simulation/physics/fluid/boundary_conditions/outlet/outlet_strategy/fan_curve_outlet_.py +5 -4
  140. luminarycloud/params/simulation/physics/fluid/boundary_conditions/outlet/outlet_strategy/outlet_pressure_.py +3 -2
  141. luminarycloud/params/simulation/physics/fluid/boundary_conditions/outlet/outlet_strategy/outlet_target_corrected_mass_flow_rate_.py +3 -2
  142. luminarycloud/params/simulation/physics/fluid/boundary_conditions/outlet/outlet_strategy/outlet_target_mass_flow_rate_.py +3 -2
  143. luminarycloud/params/simulation/physics/fluid/boundary_conditions/outlet/outlet_strategy_.py +3 -2
  144. luminarycloud/params/simulation/physics/fluid/boundary_conditions/outlet_.py +6 -5
  145. luminarycloud/params/simulation/physics/fluid/boundary_conditions/symmetry_.py +5 -4
  146. luminarycloud/params/simulation/physics/fluid/boundary_conditions/turbulence_boundary_conditions_.py +3 -2
  147. luminarycloud/params/simulation/physics/fluid/boundary_conditions/wall/energy/__init__.py +1 -1
  148. luminarycloud/params/simulation/physics/fluid/boundary_conditions/wall/energy/prescribed_heat_flux_.py +3 -2
  149. luminarycloud/params/simulation/physics/fluid/boundary_conditions/wall/energy/prescribed_temperature_.py +3 -2
  150. luminarycloud/params/simulation/physics/fluid/boundary_conditions/wall/momentum/__init__.py +1 -1
  151. luminarycloud/params/simulation/physics/fluid/boundary_conditions/wall/momentum/no_slip_.py +3 -2
  152. luminarycloud/params/simulation/physics/fluid/boundary_conditions/wall/momentum/slip_.py +3 -2
  153. luminarycloud/params/simulation/physics/fluid/boundary_conditions/wall/momentum/wall_model_.py +3 -2
  154. luminarycloud/params/simulation/physics/fluid/boundary_conditions/wall/wall_energy_.py +3 -2
  155. luminarycloud/params/simulation/physics/fluid/boundary_conditions/wall/wall_momentum_.py +3 -2
  156. luminarycloud/params/simulation/physics/fluid/boundary_conditions/wall_.py +7 -6
  157. luminarycloud/params/simulation/physics/fluid/boundary_conditions_fluid_.py +3 -2
  158. luminarycloud/params/simulation/physics/fluid/initialization/__init__.py +2 -2
  159. luminarycloud/params/simulation/physics/fluid/initialization/fluid_existing_solution_.py +5 -4
  160. luminarycloud/params/simulation/physics/fluid/initialization/fluid_farfield_values_.py +5 -4
  161. luminarycloud/params/simulation/physics/fluid/initialization/fluid_prescribed_values_.py +5 -4
  162. luminarycloud/params/simulation/physics/fluid/initialization/turbulence_initialization_.py +3 -2
  163. luminarycloud/params/simulation/physics/fluid/initialization_fluid_.py +3 -2
  164. luminarycloud/params/simulation/physics/fluid/physical_behavior/__init__.py +1 -1
  165. luminarycloud/params/simulation/physics/fluid/physical_behavior/blade_element_airfoil_data_.py +8 -7
  166. luminarycloud/params/simulation/physics/fluid/physical_behavior/physical_behavior_model/__init__.py +1 -1
  167. luminarycloud/params/simulation/physics/fluid/physical_behavior/physical_behavior_model/actuator_disk_model/__init__.py +2 -2
  168. luminarycloud/params/simulation/physics/fluid/physical_behavior/physical_behavior_model/actuator_disk_model/actuator_disk_blade_element_.py +3 -2
  169. luminarycloud/params/simulation/physics/fluid/physical_behavior/physical_behavior_model/actuator_disk_model/actuator_disk_radial_distribution_.py +8 -7
  170. luminarycloud/params/simulation/physics/fluid/physical_behavior/physical_behavior_model/actuator_disk_model/actuator_disk_uniform_thrust_.py +4 -3
  171. luminarycloud/params/simulation/physics/fluid/physical_behavior/physical_behavior_model/actuator_disk_model/fan_curve_internal_.py +5 -4
  172. luminarycloud/params/simulation/physics/fluid/physical_behavior/physical_behavior_model/actuator_disk_model_.py +3 -2
  173. luminarycloud/params/simulation/physics/fluid/physical_behavior/physical_behavior_model/actuator_line_model/actuator_line_blade_element_.py +3 -2
  174. luminarycloud/params/simulation/physics/fluid/physical_behavior/physical_behavior_model/actuator_line_model_.py +3 -2
  175. luminarycloud/params/simulation/physics/fluid/physical_behavior/physical_behavior_model/blade_element_params_.py +9 -8
  176. luminarycloud/params/simulation/physics/fluid/physical_behavior/physical_behavior_model/particle_source_model/general_acceleration_source_.py +4 -3
  177. luminarycloud/params/simulation/physics/fluid/physical_behavior/physical_behavior_model/particle_source_model/general_mass_source_.py +4 -3
  178. luminarycloud/params/simulation/physics/fluid/physical_behavior/physical_behavior_model/particle_source_model_.py +3 -2
  179. luminarycloud/params/simulation/physics/fluid/physical_behavior/physical_behavior_model_.py +3 -2
  180. luminarycloud/params/simulation/physics/fluid/physical_behavior_.py +5 -4
  181. luminarycloud/params/simulation/physics/fluid/porous_behavior_.py +3 -2
  182. luminarycloud/params/simulation/physics/fluid/solution_controls/__init__.py +1 -1
  183. luminarycloud/params/simulation/physics/fluid/solution_controls/fluid_relaxation_method/fluid_explicit_relaxation_.py +3 -2
  184. luminarycloud/params/simulation/physics/fluid/solution_controls/fluid_relaxation_method/fluid_implicit_relaxation/robust_startup/robust_startup_off_.py +3 -2
  185. luminarycloud/params/simulation/physics/fluid/solution_controls/fluid_relaxation_method/fluid_implicit_relaxation/robust_startup/robust_startup_on_.py +3 -2
  186. luminarycloud/params/simulation/physics/fluid/solution_controls/fluid_relaxation_method/fluid_implicit_relaxation/robust_startup_.py +3 -2
  187. luminarycloud/params/simulation/physics/fluid/solution_controls/fluid_relaxation_method/fluid_implicit_relaxation_.py +7 -6
  188. luminarycloud/params/simulation/physics/fluid/solution_controls/fluid_relaxation_method_.py +3 -2
  189. luminarycloud/params/simulation/physics/fluid/solution_controls/pseudo_time_step_method/__init__.py +1 -1
  190. luminarycloud/params/simulation/physics/fluid/solution_controls/pseudo_time_step_method/cfl_based_.py +3 -2
  191. luminarycloud/params/simulation/physics/fluid/solution_controls/pseudo_time_step_method/fixed_pseudo_time_step_.py +3 -2
  192. luminarycloud/params/simulation/physics/fluid/solution_controls/pseudo_time_step_method_.py +3 -2
  193. luminarycloud/params/simulation/physics/fluid/solution_controls_fluid_.py +5 -4
  194. luminarycloud/params/simulation/physics/fluid/spatial_discretization/__init__.py +1 -1
  195. luminarycloud/params/simulation/physics/fluid/spatial_discretization/convective_scheme/__init__.py +1 -1
  196. luminarycloud/params/simulation/physics/fluid/spatial_discretization/convective_scheme/ec2_.py +3 -2
  197. luminarycloud/params/simulation/physics/fluid/spatial_discretization/convective_scheme/fds_.py +3 -2
  198. luminarycloud/params/simulation/physics/fluid/spatial_discretization/convective_scheme/ld2_.py +3 -2
  199. luminarycloud/params/simulation/physics/fluid/spatial_discretization/convective_scheme/rhie_chow_.py +3 -2
  200. luminarycloud/params/simulation/physics/fluid/spatial_discretization/convective_scheme_.py +3 -2
  201. luminarycloud/params/simulation/physics/fluid/spatial_discretization/convective_scheme_order/first_order_.py +3 -2
  202. luminarycloud/params/simulation/physics/fluid/spatial_discretization/convective_scheme_order/second_order_.py +3 -2
  203. luminarycloud/params/simulation/physics/fluid/spatial_discretization/convective_scheme_order_.py +3 -2
  204. luminarycloud/params/simulation/physics/fluid/spatial_discretization_fluid_.py +5 -4
  205. luminarycloud/params/simulation/physics/fluid/turbulence/__init__.py +2 -2
  206. luminarycloud/params/simulation/physics/fluid/turbulence/des_formulation/__init__.py +1 -1
  207. luminarycloud/params/simulation/physics/fluid/turbulence/des_formulation/ddes_.py +3 -2
  208. luminarycloud/params/simulation/physics/fluid/turbulence/des_formulation/ddes_vtm_.py +3 -2
  209. luminarycloud/params/simulation/physics/fluid/turbulence/des_formulation/iddes_.py +3 -2
  210. luminarycloud/params/simulation/physics/fluid/turbulence/des_formulation_.py +3 -2
  211. luminarycloud/params/simulation/physics/fluid/turbulence/komega_sst/constants/custom_komega_sst_constants_.py +3 -2
  212. luminarycloud/params/simulation/physics/fluid/turbulence/komega_sst/constants/default_komega_sst_constants_.py +3 -2
  213. luminarycloud/params/simulation/physics/fluid/turbulence/komega_sst/komega_sst_constants_.py +3 -2
  214. luminarycloud/params/simulation/physics/fluid/turbulence/komega_sst_.py +6 -5
  215. luminarycloud/params/simulation/physics/fluid/turbulence/spalart_allmaras/constants/custom_spalart_allmaras_constants_.py +3 -2
  216. luminarycloud/params/simulation/physics/fluid/turbulence/spalart_allmaras/constants/default_spalart_allmaras_constants_.py +3 -2
  217. luminarycloud/params/simulation/physics/fluid/turbulence/spalart_allmaras/spalart_allmaras_constants_.py +3 -2
  218. luminarycloud/params/simulation/physics/fluid/turbulence/spalart_allmaras_.py +6 -5
  219. luminarycloud/params/simulation/physics/fluid/turbulence/sub_grid_scale_model/__init__.py +2 -2
  220. luminarycloud/params/simulation/physics/fluid/turbulence/sub_grid_scale_model/amd_.py +3 -2
  221. luminarycloud/params/simulation/physics/fluid/turbulence/sub_grid_scale_model/sigma_.py +3 -2
  222. luminarycloud/params/simulation/physics/fluid/turbulence/sub_grid_scale_model/smagorinsky_.py +3 -2
  223. luminarycloud/params/simulation/physics/fluid/turbulence/sub_grid_scale_model/vreman_.py +3 -2
  224. luminarycloud/params/simulation/physics/fluid/turbulence/sub_grid_scale_model/wale_.py +3 -2
  225. luminarycloud/params/simulation/physics/fluid/turbulence/sub_grid_scale_model_.py +3 -2
  226. luminarycloud/params/simulation/physics/fluid/turbulence_.py +6 -5
  227. luminarycloud/params/simulation/physics/fluid_.py +12 -13
  228. luminarycloud/params/simulation/physics/heat/__init__.py +4 -4
  229. luminarycloud/params/simulation/physics/heat/adjoint_controls_heat_.py +3 -2
  230. luminarycloud/params/simulation/physics/heat/boundary_conditions/__init__.py +2 -2
  231. luminarycloud/params/simulation/physics/heat/boundary_conditions/heat_bc_convection_.py +5 -4
  232. luminarycloud/params/simulation/physics/heat/boundary_conditions/heat_bc_heat_flux_.py +5 -4
  233. luminarycloud/params/simulation/physics/heat/boundary_conditions/heat_bc_integrated_heat_flux_.py +5 -4
  234. luminarycloud/params/simulation/physics/heat/boundary_conditions/heat_bc_symmetry_.py +5 -4
  235. luminarycloud/params/simulation/physics/heat/boundary_conditions/heat_bc_temperature_.py +5 -4
  236. luminarycloud/params/simulation/physics/heat/boundary_conditions_heat_.py +5 -4
  237. luminarycloud/params/simulation/physics/heat/heat_source/heat_source_type/__init__.py +1 -1
  238. luminarycloud/params/simulation/physics/heat/heat_source/heat_source_type/heat_source_type_power_.py +3 -2
  239. luminarycloud/params/simulation/physics/heat/heat_source/heat_source_type/heat_source_type_power_per_unit_of_volume_.py +4 -3
  240. luminarycloud/params/simulation/physics/heat/heat_source/heat_source_type_.py +3 -2
  241. luminarycloud/params/simulation/physics/heat/heat_source_.py +6 -5
  242. luminarycloud/params/simulation/physics/heat/initialization/heat_existing_solution_.py +5 -4
  243. luminarycloud/params/simulation/physics/heat/initialization/heat_prescribed_values_.py +5 -4
  244. luminarycloud/params/simulation/physics/heat/initialization_heat_.py +3 -2
  245. luminarycloud/params/simulation/physics/heat/solution_controls/heat_relaxation_method/heat_implicit_relaxation_.py +4 -3
  246. luminarycloud/params/simulation/physics/heat/solution_controls/heat_relaxation_method_.py +3 -2
  247. luminarycloud/params/simulation/physics/heat/solution_controls_heat_.py +4 -3
  248. luminarycloud/params/simulation/physics/heat/spatial_discretization_heat_.py +3 -2
  249. luminarycloud/params/simulation/physics/heat_.py +9 -8
  250. luminarycloud/params/simulation/physics/periodic_pair/periodicity_type/__init__.py +1 -1
  251. luminarycloud/params/simulation/physics/periodic_pair/periodicity_type/rotational_periodicity_.py +3 -2
  252. luminarycloud/params/simulation/physics/periodic_pair/periodicity_type/translational_periodicity_.py +3 -2
  253. luminarycloud/params/simulation/physics/periodic_pair/periodicity_type_.py +3 -2
  254. luminarycloud/params/simulation/physics/periodic_pair_.py +4 -3
  255. luminarycloud/params/simulation/physics/solution_controls/linear_solver_type/__init__.py +1 -1
  256. luminarycloud/params/simulation/physics/solution_controls/linear_solver_type/gauss_seidel_.py +3 -2
  257. luminarycloud/params/simulation/physics/solution_controls/linear_solver_type/krylov_amg_.py +9 -8
  258. luminarycloud/params/simulation/physics/solution_controls/linear_solver_type_.py +3 -2
  259. luminarycloud/params/simulation/physics_.py +7 -6
  260. luminarycloud/params/simulation/simulation_param_.py +12 -13
  261. luminarycloud/params/simulation/sliding_interfaces_.py +8 -7
  262. luminarycloud/params/simulation/surface_name_.py +3 -2
  263. luminarycloud/params/simulation/time/__init__.py +2 -2
  264. luminarycloud/params/simulation/time/compute_statistics/__init__.py +1 -1
  265. luminarycloud/params/simulation/time/compute_statistics/compute_statistics_off_.py +3 -2
  266. luminarycloud/params/simulation/time/compute_statistics/compute_statistics_on_.py +3 -2
  267. luminarycloud/params/simulation/time/compute_statistics_.py +3 -2
  268. luminarycloud/params/simulation/time/time_marching/time_explicit_.py +3 -2
  269. luminarycloud/params/simulation/time/time_marching/time_implicit_.py +3 -2
  270. luminarycloud/params/simulation/time/time_marching_.py +3 -2
  271. luminarycloud/params/simulation/time/time_step_ramp/time_step_ramp_off_.py +3 -2
  272. luminarycloud/params/simulation/time/time_step_ramp/time_step_ramp_on_.py +3 -2
  273. luminarycloud/params/simulation/time/time_step_ramp_.py +3 -2
  274. luminarycloud/params/simulation/time_.py +6 -5
  275. luminarycloud/params/simulation/volume_entity_.py +5 -4
  276. luminarycloud/physics_ai/__init__.py +8 -0
  277. luminarycloud/physics_ai/architectures.py +38 -0
  278. luminarycloud/physics_ai/models.py +42 -0
  279. luminarycloud/project.py +73 -21
  280. luminarycloud/reference_values.py +20 -3
  281. luminarycloud/simulation.py +8 -3
  282. luminarycloud/simulation_param.py +136 -29
  283. luminarycloud/simulation_template.py +84 -13
  284. luminarycloud/solution.py +17 -2
  285. luminarycloud/types/__init__.py +1 -0
  286. luminarycloud/types/adfloat.py +49 -19
  287. luminarycloud/types/ids.py +3 -0
  288. luminarycloud/vis/__init__.py +0 -3
  289. luminarycloud/vis/display.py +1 -0
  290. luminarycloud/vis/interactive_scene.py +47 -1
  291. luminarycloud/vis/visualization.py +57 -23
  292. luminarycloud/volume_selection.py +31 -19
  293. {luminarycloud-0.14.0.dist-info → luminarycloud-0.15.0.dist-info}/METADATA +2 -2
  294. {luminarycloud-0.14.0.dist-info → luminarycloud-0.15.0.dist-info}/RECORD +295 -274
  295. {luminarycloud-0.14.0.dist-info → luminarycloud-0.15.0.dist-info}/WHEEL +0 -0
@@ -27,6 +27,7 @@ class UnitSystem(_IntEnum):
27
27
  >>> UnitSystem.UNIT_SYSTEM_US
28
28
  """
29
29
 
30
+ INVALID = _clientpb.INVALID_UNIT_SYSTEM
30
31
  UNIT_SYSTEM_CUSTOM = _clientpb.UNIT_SYSTEM_CUSTOM
31
32
  UNIT_SYSTEM_SI = _clientpb.UNIT_SYSTEM_SI
32
33
  UNIT_SYSTEM_US = _clientpb.UNIT_SYSTEM_US
@@ -57,6 +58,7 @@ class TemperatureUnit(_IntEnum):
57
58
  >>> TemperatureUnit.UNIT_FAHRENHEIT
58
59
  """
59
60
 
61
+ INVALID = _clientpb.INVALID_TEMPERATURE_UNIT
60
62
  UNIT_KELVIN = _clientpb.UNIT_KELVIN
61
63
  UNIT_CELSIUS = _clientpb.UNIT_CELSIUS
62
64
  UNIT_RANKINE = _clientpb.UNIT_RANKINE
@@ -85,6 +87,7 @@ class MassUnit(_IntEnum):
85
87
  >>> MassUnit.UNIT_POUND
86
88
  """
87
89
 
90
+ INVALID = _clientpb.INVALID_MASS_UNIT
88
91
  UNIT_KILOGRAM = _clientpb.UNIT_KILOGRAM
89
92
  UNIT_GRAM = _clientpb.UNIT_GRAM
90
93
  UNIT_POUND = _clientpb.UNIT_POUND
@@ -115,6 +118,7 @@ class LengthUnit(_IntEnum):
115
118
  >>> LengthUnit.UNIT_INCH
116
119
  """
117
120
 
121
+ INVALID = _clientpb.INVALID_LENGTH_UNIT
118
122
  UNIT_METER = _clientpb.UNIT_METER
119
123
  UNIT_MILLIMETER = _clientpb.UNIT_MILLIMETER
120
124
  UNIT_FOOT = _clientpb.UNIT_FOOT
@@ -140,6 +144,7 @@ class AngleUnit(_IntEnum):
140
144
  >>> AngleUnit.UNIT_RADIAN
141
145
  """
142
146
 
147
+ INVALID = _clientpb.INVALID_ANGLE_UNIT
143
148
  UNIT_DEGREE = _clientpb.UNIT_DEGREE
144
149
  UNIT_RADIAN = _clientpb.UNIT_RADIAN
145
150
 
@@ -160,6 +165,7 @@ class TimeUnit(_IntEnum):
160
165
  >>> TimeUnit.UNIT_SECOND
161
166
  """
162
167
 
168
+ INVALID = _clientpb.INVALID_TIME_UNIT
163
169
  UNIT_SECOND = _clientpb.UNIT_SECOND
164
170
 
165
171
 
@@ -188,6 +194,7 @@ class VelocityUnit(_IntEnum):
188
194
  >>> VelocityUnit.UNIT_MILES_PER_HOUR
189
195
  """
190
196
 
197
+ INVALID = _clientpb.INVALID_VELOCITY_UNIT
191
198
  UNIT_METER_PER_SECOND = _clientpb.UNIT_METER_PER_SECOND
192
199
  UNIT_KM_PER_HOUR = _clientpb.UNIT_KM_PER_HOUR
193
200
  UNIT_FEET_PER_SECOND = _clientpb.UNIT_FEET_PER_SECOND
@@ -213,6 +220,7 @@ class AngularVelocityUnit(_IntEnum):
213
220
  >>> AngularVelocityUnit.UNIT_RPM
214
221
  """
215
222
 
223
+ INVALID = _clientpb.INVALID_ANGULAR_VELOCITY_UNIT
216
224
  UNIT_RADIAN_PER_SECOND = _clientpb.UNIT_RADIAN_PER_SECOND
217
225
  UNIT_RPM = _clientpb.UNIT_RPM
218
226
 
@@ -236,6 +244,7 @@ class ForceUnit(_IntEnum):
236
244
  >>> ForceUnit.UNIT_POUND_FORCE
237
245
  """
238
246
 
247
+ INVALID = _clientpb.INVALID_FORCE_UNIT
239
248
  UNIT_NEWTON = _clientpb.UNIT_NEWTON
240
249
  UNIT_POUND_FORCE = _clientpb.UNIT_POUND_FORCE
241
250
 
@@ -259,6 +268,7 @@ class MomentUnit(_IntEnum):
259
268
  >>> MomentUnit.UNIT_POUND_FOOT
260
269
  """
261
270
 
271
+ INVALID = _clientpb.INVALID_MOMENT_UNIT
262
272
  UNIT_NEWTON_METER = _clientpb.UNIT_NEWTON_METER
263
273
  UNIT_POUND_FOOT = _clientpb.UNIT_POUND_FOOT
264
274
 
@@ -285,6 +295,7 @@ class PressureUnit(_IntEnum):
285
295
  >>> PressureUnit.UNIT_PSI
286
296
  """
287
297
 
298
+ INVALID = _clientpb.INVALID_PRESSURE_UNIT
288
299
  UNIT_PASCAL = _clientpb.UNIT_PASCAL
289
300
  UNIT_BAR = _clientpb.UNIT_BAR
290
301
  UNIT_PSI = _clientpb.UNIT_PSI
@@ -309,6 +320,7 @@ class EnergyUnit(_IntEnum):
309
320
  >>> EnergyUnit.UNIT_BTU
310
321
  """
311
322
 
323
+ INVALID = _clientpb.INVALID_ENERGY_UNIT
312
324
  UNIT_JOULE = _clientpb.UNIT_JOULE
313
325
  UNIT_BTU = _clientpb.UNIT_BTU
314
326
 
@@ -332,6 +344,7 @@ class PowerUnit(_IntEnum):
332
344
  >>> PowerUnit.UNIT_HORSEPOWER
333
345
  """
334
346
 
347
+ INVALID = _clientpb.INVALID_POWER_UNIT
335
348
  UNIT_WATT = _clientpb.UNIT_WATT
336
349
  UNIT_HORSEPOWER = _clientpb.UNIT_HORSEPOWER
337
350
 
@@ -364,6 +377,7 @@ class VolumeUnit(_IntEnum):
364
377
  >>> VolumeUnit.UNIT_CUBIC_FOOT
365
378
  """
366
379
 
380
+ INVALID = _clientpb.INVALID_VOLUME_UNIT
367
381
  UNIT_CUBIC_METER = _clientpb.UNIT_CUBIC_METER
368
382
  UNIT_LITER = _clientpb.UNIT_LITER
369
383
  UNIT_GALLON = _clientpb.UNIT_GALLON
@@ -390,6 +404,7 @@ class VolumetricFlowUnit(_IntEnum):
390
404
  >>> VolumetricFlowUnit.UNIT_CFM
391
405
  """
392
406
 
407
+ INVALID = _clientpb.INVALID_VOLUMETRIC_FLOW_UNIT
393
408
  UNIT_CUBIC_METER_PER_SECOND = _clientpb.UNIT_CUBIC_METER_PER_SECOND
394
409
  UNIT_CFM = _clientpb.UNIT_CFM
395
410
 
@@ -416,6 +431,7 @@ class ViscosityUnit(_IntEnum):
416
431
  >>> ViscosityUnit.UNIT_POUND_SECOND_PER_SQUARE_FOOT
417
432
  """
418
433
 
434
+ INVALID = _clientpb.INVALID_VISCOSITY_UNIT
419
435
  UNIT_PASCAL_SECOND = _clientpb.UNIT_PASCAL_SECOND
420
436
  UNIT_CENTIPOISE = _clientpb.UNIT_CENTIPOISE
421
437
  UNIT_POUND_SECOND_PER_SQUARE_FOOT = _clientpb.UNIT_POUND_SECOND_PER_SQUARE_FOOT
@@ -440,6 +456,7 @@ class ConductivityUnit(_IntEnum):
440
456
  >>> ConductivityUnit.UNIT_BTU_PER_HOUR_FOOT_FAHRENHEIT
441
457
  """
442
458
 
459
+ INVALID = _clientpb.INVALID_CONDUCTIVITY_UNIT
443
460
  UNIT_WATT_PER_METER_KELVIN = _clientpb.UNIT_WATT_PER_METER_KELVIN
444
461
  UNIT_BTU_PER_HOUR_FOOT_FAHRENHEIT = _clientpb.UNIT_BTU_PER_HOUR_FOOT_FAHRENHEIT
445
462
 
@@ -463,89 +480,11 @@ class MolecularWeightUnit(_IntEnum):
463
480
  >>> MolecularWeightUnit.UNIT_POUND_PER_POUND_MOLE
464
481
  """
465
482
 
483
+ INVALID = _clientpb.INVALID_MOLECULAR_WEIGHT_UNIT
466
484
  UNIT_GRAM_PER_MOLE = _clientpb.UNIT_GRAM_PER_MOLE
467
485
  UNIT_POUND_PER_POUND_MOLE = _clientpb.UNIT_POUND_PER_POUND_MOLE
468
486
 
469
487
 
470
- class DensityRelationship(_IntEnum):
471
- """
472
- Relationship for computing the density of the fluid.
473
-
474
- Attributes
475
- ----------
476
- IDEAL_GAS
477
- Compute density using the ideal gas law.
478
- CONSTANT_DENSITY
479
- Constant density fluid (heat transfer is not simulated).
480
- CONSTANT_DENSITY_ENERGY
481
- Constant density fluid with energy equation.
482
-
483
-
484
- Examples
485
- --------
486
- >>> from luminarycloud.params.enum import DensityRelationship
487
- >>> DensityRelationship.IDEAL_GAS
488
- >>> DensityRelationship.CONSTANT_DENSITY
489
- >>> DensityRelationship.CONSTANT_DENSITY_ENERGY
490
- """
491
-
492
- IDEAL_GAS = _clientpb.IDEAL_GAS
493
- CONSTANT_DENSITY = _clientpb.CONSTANT_DENSITY
494
- CONSTANT_DENSITY_ENERGY = _clientpb.CONSTANT_DENSITY_ENERGY
495
-
496
-
497
- class LaminarThermalConductivity(_IntEnum):
498
- """
499
- Model for the laminar thermal conductivity of a fluid.
500
-
501
- Attributes
502
- ----------
503
- LAMINAR_CONSTANT_THERMAL_PRANDTL
504
- Laminar thermal conductivity as function of local specific heat, laminar viscosity, and the specified laminar Prandtl number.
505
- LAMINAR_CONSTANT_THERMAL_CONDUCTIVITY
506
- Constant laminar thermal conductivity or tabulated values vs temperature.
507
- TEMPERATURE_DEPENDENT_THERMAL_CONDUCTIVITY
508
- Tabulated thermal conductivity values vs temperature.
509
-
510
-
511
- Examples
512
- --------
513
- >>> from luminarycloud.params.enum import LaminarThermalConductivity
514
- >>> LaminarThermalConductivity.LAMINAR_CONSTANT_THERMAL_PRANDTL
515
- >>> LaminarThermalConductivity.LAMINAR_CONSTANT_THERMAL_CONDUCTIVITY
516
- >>> LaminarThermalConductivity.TEMPERATURE_DEPENDENT_THERMAL_CONDUCTIVITY
517
- """
518
-
519
- LAMINAR_CONSTANT_THERMAL_PRANDTL = _clientpb.LAMINAR_CONSTANT_THERMAL_PRANDTL
520
- LAMINAR_CONSTANT_THERMAL_CONDUCTIVITY = _clientpb.LAMINAR_CONSTANT_THERMAL_CONDUCTIVITY
521
- TEMPERATURE_DEPENDENT_THERMAL_CONDUCTIVITY = (
522
- _clientpb.TEMPERATURE_DEPENDENT_THERMAL_CONDUCTIVITY
523
- )
524
-
525
-
526
- class BoussinesqApproximation(_IntEnum):
527
- """
528
- Introduce a body force due to thermal expansion without modifying the material density.
529
-
530
- Attributes
531
- ----------
532
- BOUSSINESQ_OFF
533
- Disable Boussinesq approximation.
534
- BOUSSINESQ_ON
535
- Enable Boussinesq approximation.
536
-
537
-
538
- Examples
539
- --------
540
- >>> from luminarycloud.params.enum import BoussinesqApproximation
541
- >>> BoussinesqApproximation.BOUSSINESQ_OFF
542
- >>> BoussinesqApproximation.BOUSSINESQ_ON
543
- """
544
-
545
- BOUSSINESQ_OFF = _clientpb.BOUSSINESQ_OFF
546
- BOUSSINESQ_ON = _clientpb.BOUSSINESQ_ON
547
-
548
-
549
488
  class MaterialFluidPreset(_IntEnum):
550
489
  """
551
490
  Select a predefined set of material properties or allow a custom set of properties.
@@ -571,39 +510,13 @@ class MaterialFluidPreset(_IntEnum):
571
510
  >>> MaterialFluidPreset.CUSTOM_MATERIAL_FLUID
572
511
  """
573
512
 
513
+ INVALID = _clientpb.INVALID_MATERIAL_FLUID_PRESET
574
514
  UNSET_MATERIAL_FLUID_PRESET = _clientpb.UNSET_MATERIAL_FLUID_PRESET
575
515
  STANDARD_AIR = _clientpb.STANDARD_AIR
576
516
  WATER_NTP = _clientpb.WATER_NTP
577
517
  CUSTOM_MATERIAL_FLUID = _clientpb.CUSTOM_MATERIAL_FLUID
578
518
 
579
519
 
580
- class LaminarViscosityModelNewtonian(_IntEnum):
581
- """
582
- Models available for the dynamic viscosity of the fluid.
583
-
584
- Attributes
585
- ----------
586
- SUTHERLAND
587
- Dynamic viscosity as a function of local temperature using Sutherland's Law.
588
- LAMINAR_CONSTANT_VISCOSITY
589
- Constant dynamic viscosity or tabulated values vs temperature.
590
- TEMPERATURE_DEPENDENT_LAMINAR_VISCOSITY
591
- Tabulated dynamic viscosity values vs temperature.
592
-
593
-
594
- Examples
595
- --------
596
- >>> from luminarycloud.params.enum import LaminarViscosityModelNewtonian
597
- >>> LaminarViscosityModelNewtonian.SUTHERLAND
598
- >>> LaminarViscosityModelNewtonian.LAMINAR_CONSTANT_VISCOSITY
599
- >>> LaminarViscosityModelNewtonian.TEMPERATURE_DEPENDENT_LAMINAR_VISCOSITY
600
- """
601
-
602
- SUTHERLAND = _clientpb.SUTHERLAND
603
- LAMINAR_CONSTANT_VISCOSITY = _clientpb.LAMINAR_CONSTANT_VISCOSITY
604
- TEMPERATURE_DEPENDENT_LAMINAR_VISCOSITY = _clientpb.TEMPERATURE_DEPENDENT_LAMINAR_VISCOSITY
605
-
606
-
607
520
  class MaterialSolidPreset(_IntEnum):
608
521
  """
609
522
  Select a predefined set of material properties or allow a custom set of properties.
@@ -635,6 +548,7 @@ class MaterialSolidPreset(_IntEnum):
635
548
  >>> MaterialSolidPreset.CUSTOM_MATERIAL_SOLID
636
549
  """
637
550
 
551
+ INVALID = _clientpb.INVALID_MATERIAL_SOLID_PRESET
638
552
  ALUMINUM = _clientpb.ALUMINUM
639
553
  COPPER = _clientpb.COPPER
640
554
  IRON = _clientpb.IRON
@@ -666,34 +580,12 @@ class FloatType(_IntEnum):
666
580
  >>> FloatType.ADA1D
667
581
  """
668
582
 
583
+ INVALID = _clientpb.INVALID_FLOAT_TYPE
669
584
  DOUBLE = _clientpb.DOUBLE
670
585
  ADT1D = _clientpb.ADT1D
671
586
  ADA1D = _clientpb.ADA1D
672
587
 
673
588
 
674
- class Gravity(_IntEnum):
675
- """
676
- Apply an acceleration due to gravity or other body force.
677
-
678
- Attributes
679
- ----------
680
- GRAVITY_OFF
681
- Disable gravity or other body force.
682
- GRAVITY_ON
683
- Enable gravity or other body force.
684
-
685
-
686
- Examples
687
- --------
688
- >>> from luminarycloud.params.enum import Gravity
689
- >>> Gravity.GRAVITY_OFF
690
- >>> Gravity.GRAVITY_ON
691
- """
692
-
693
- GRAVITY_OFF = _clientpb.GRAVITY_OFF
694
- GRAVITY_ON = _clientpb.GRAVITY_ON
695
-
696
-
697
589
  class FlowBehavior(_IntEnum):
698
590
  """
699
591
  Importance of physical time for the current simulation.
@@ -713,33 +605,11 @@ class FlowBehavior(_IntEnum):
713
605
  >>> FlowBehavior.TRANSIENT
714
606
  """
715
607
 
608
+ INVALID = _clientpb.INVALID_FLOW_BEHAVIOR
716
609
  STEADY = _clientpb.STEADY
717
610
  TRANSIENT = _clientpb.TRANSIENT
718
611
 
719
612
 
720
- class TimeMarching(_IntEnum):
721
- """
722
- Scheme for time-accurate integration.
723
-
724
- Attributes
725
- ----------
726
- TIME_IMPLICIT
727
- Implicit scheme (dual time stepping) for time-accurate integration.
728
- TIME_EXPLICIT
729
- Explicit scheme for time-accurate integration.
730
-
731
-
732
- Examples
733
- --------
734
- >>> from luminarycloud.params.enum import TimeMarching
735
- >>> TimeMarching.TIME_IMPLICIT
736
- >>> TimeMarching.TIME_EXPLICIT
737
- """
738
-
739
- TIME_IMPLICIT = _clientpb.TIME_IMPLICIT
740
- TIME_EXPLICIT = _clientpb.TIME_EXPLICIT
741
-
742
-
743
613
  class TimeImplicitOrder(_IntEnum):
744
614
  """
745
615
  Temporal order of accuracy of the dual time stepping scheme for time-accurate integration.
@@ -759,6 +629,7 @@ class TimeImplicitOrder(_IntEnum):
759
629
  >>> TimeImplicitOrder.TIME_FIRST
760
630
  """
761
631
 
632
+ INVALID = _clientpb.INVALID_TIME_IMPLICIT_ORDER
762
633
  TIME_SECOND = _clientpb.TIME_SECOND
763
634
  TIME_FIRST = _clientpb.TIME_FIRST
764
635
 
@@ -779,88 +650,10 @@ class PhysicalTimeStepMethod(_IntEnum):
779
650
  >>> PhysicalTimeStepMethod.FIXED_TIME_STEP
780
651
  """
781
652
 
653
+ INVALID = _clientpb.INVALID_PHYSICAL_TIME_STEP_METHOD
782
654
  FIXED_TIME_STEP = _clientpb.FIXED_TIME_STEP
783
655
 
784
656
 
785
- class TimeStepRamp(_IntEnum):
786
- """
787
- Use a larger time step value during the initial transients of a simulation and then ramp
788
- linearly towards the target value, to accelerate statistical convergence. Only applicable to
789
- transient problems with time implicit integration (dual time stepping).
790
-
791
- Attributes
792
- ----------
793
- TIME_STEP_RAMP_OFF
794
- Disable physical time step ramping.
795
- TIME_STEP_RAMP_ON
796
- Enable physical time step ramping.
797
-
798
-
799
- Examples
800
- --------
801
- >>> from luminarycloud.params.enum import TimeStepRamp
802
- >>> TimeStepRamp.TIME_STEP_RAMP_OFF
803
- >>> TimeStepRamp.TIME_STEP_RAMP_ON
804
- """
805
-
806
- TIME_STEP_RAMP_OFF = _clientpb.TIME_STEP_RAMP_OFF
807
- TIME_STEP_RAMP_ON = _clientpb.TIME_STEP_RAMP_ON
808
-
809
-
810
- class ComputeStatistics(_IntEnum):
811
- """
812
- Compute time-averaged values of flow variables (e.g. Velocity).
813
-
814
- Attributes
815
- ----------
816
- COMPUTE_STATISTICS_OFF
817
- Disable computation of transient statistics.
818
- COMPUTE_STATISTICS_ON
819
- Enable computation of transient statistics.
820
-
821
-
822
- Examples
823
- --------
824
- >>> from luminarycloud.params.enum import ComputeStatistics
825
- >>> ComputeStatistics.COMPUTE_STATISTICS_OFF
826
- >>> ComputeStatistics.COMPUTE_STATISTICS_ON
827
- """
828
-
829
- COMPUTE_STATISTICS_OFF = _clientpb.COMPUTE_STATISTICS_OFF
830
- COMPUTE_STATISTICS_ON = _clientpb.COMPUTE_STATISTICS_ON
831
-
832
-
833
- class MotionType(_IntEnum):
834
- """
835
- Type of the Motion.
836
-
837
- Attributes
838
- ----------
839
- NO_MOTION
840
- No relative motion.
841
- CONSTANT_TRANSLATION_MOTION
842
- Motion is defined by specifying an initial translation and constant translational velocity.
843
- CONSTANT_ANGULAR_MOTION
844
- Motion is defined by specifying an initial rotation and constant angular velocity.
845
- CONSTANT_VELOCITY_MOTION
846
- Motion is defined by specifying constant translational and angular velocities.
847
-
848
-
849
- Examples
850
- --------
851
- >>> from luminarycloud.params.enum import MotionType
852
- >>> MotionType.NO_MOTION
853
- >>> MotionType.CONSTANT_TRANSLATION_MOTION
854
- >>> MotionType.CONSTANT_ANGULAR_MOTION
855
- >>> MotionType.CONSTANT_VELOCITY_MOTION
856
- """
857
-
858
- NO_MOTION = _clientpb.NO_MOTION
859
- CONSTANT_TRANSLATION_MOTION = _clientpb.CONSTANT_TRANSLATION_MOTION
860
- CONSTANT_ANGULAR_MOTION = _clientpb.CONSTANT_ANGULAR_MOTION
861
- CONSTANT_VELOCITY_MOTION = _clientpb.CONSTANT_VELOCITY_MOTION
862
-
863
-
864
657
  class MotionFormulation(_IntEnum):
865
658
  """
866
659
  Formulation used to model motion of volumes in transient simulations.
@@ -881,6 +674,7 @@ class MotionFormulation(_IntEnum):
881
674
  >>> MotionFormulation.MRF_MOTION_FORMULATION
882
675
  """
883
676
 
677
+ INVALID = _clientpb.INVALID_MOTION_FORMULATION
884
678
  AUTOMATIC_MOTION_FORMULATION = _clientpb.AUTOMATIC_MOTION_FORMULATION
885
679
  MRF_MOTION_FORMULATION = _clientpb.MRF_MOTION_FORMULATION
886
680
 
@@ -904,91 +698,11 @@ class MotionSpecification(_IntEnum):
904
698
  >>> MotionSpecification.MOTION_SPECIFICATION_NORMAL
905
699
  """
906
700
 
701
+ INVALID = _clientpb.INVALID_MOTION_SPECIFICATION
907
702
  MOTION_SPECIFICATION_REPOSITION = _clientpb.MOTION_SPECIFICATION_REPOSITION
908
703
  MOTION_SPECIFICATION_NORMAL = _clientpb.MOTION_SPECIFICATION_NORMAL
909
704
 
910
705
 
911
- class TransformType(_IntEnum):
912
- """
913
- Type of the Transformation.
914
-
915
- Attributes
916
- ----------
917
- NO_TRANSFORM
918
- No Transform
919
- ROTATIONAL_TRANSFORM
920
- Rotational Transformation
921
- TRANSLATIONAL_TRANSFORM
922
- Translational Transformation
923
-
924
-
925
- Examples
926
- --------
927
- >>> from luminarycloud.params.enum import TransformType
928
- >>> TransformType.NO_TRANSFORM
929
- >>> TransformType.ROTATIONAL_TRANSFORM
930
- >>> TransformType.TRANSLATIONAL_TRANSFORM
931
- """
932
-
933
- NO_TRANSFORM = _clientpb.NO_TRANSFORM
934
- ROTATIONAL_TRANSFORM = _clientpb.ROTATIONAL_TRANSFORM
935
- TRANSLATIONAL_TRANSFORM = _clientpb.TRANSLATIONAL_TRANSFORM
936
-
937
-
938
- class ParticleGroupType(_IntEnum):
939
- """
940
- Defines the behavior of the particles.
941
-
942
- Attributes
943
- ----------
944
- ACTUATOR_DISK
945
- Applies a uniform force at all locations on the disk
946
- ACTUATOR_LINE
947
- Applies thrust, azimuthal, and radial forces via a table of user-specified coefficients
948
- SOURCE_POINTS
949
- Injects material into the solver at particle locations
950
- PROBE_POINTS
951
- Reports solver variables at probe locations.
952
-
953
-
954
- Examples
955
- --------
956
- >>> from luminarycloud.params.enum import ParticleGroupType
957
- >>> ParticleGroupType.ACTUATOR_DISK
958
- >>> ParticleGroupType.ACTUATOR_LINE
959
- >>> ParticleGroupType.SOURCE_POINTS
960
- >>> ParticleGroupType.PROBE_POINTS
961
- """
962
-
963
- ACTUATOR_DISK = _clientpb.ACTUATOR_DISK
964
- ACTUATOR_LINE = _clientpb.ACTUATOR_LINE
965
- SOURCE_POINTS = _clientpb.SOURCE_POINTS
966
- PROBE_POINTS = _clientpb.PROBE_POINTS
967
-
968
-
969
- class ActuatorDiskOrientationSelection(_IntEnum):
970
- """
971
- Specify orientation via normal vector, or a series of x-, y-, z-rotational transformations
972
-
973
- Attributes
974
- ----------
975
- ACTUATOR_DISK_SPECIFY_ROTATION_ANGLES
976
- Specify rotation about x-, y-, and z- axes
977
- ACTUATOR_DISK_SPECIFY_NORMAL_VECTOR
978
- Specify the normal direction to the plane of the actuator disk.
979
-
980
-
981
- Examples
982
- --------
983
- >>> from luminarycloud.params.enum import ActuatorDiskOrientationSelection
984
- >>> ActuatorDiskOrientationSelection.ACTUATOR_DISK_SPECIFY_ROTATION_ANGLES
985
- >>> ActuatorDiskOrientationSelection.ACTUATOR_DISK_SPECIFY_NORMAL_VECTOR
986
- """
987
-
988
- ACTUATOR_DISK_SPECIFY_ROTATION_ANGLES = _clientpb.ACTUATOR_DISK_SPECIFY_ROTATION_ANGLES
989
- ACTUATOR_DISK_SPECIFY_NORMAL_VECTOR = _clientpb.ACTUATOR_DISK_SPECIFY_NORMAL_VECTOR
990
-
991
-
992
706
  class DebugOutput(_IntEnum):
993
707
  """
994
708
  Output debug fields in solution files.
@@ -1008,6 +722,7 @@ class DebugOutput(_IntEnum):
1008
722
  >>> DebugOutput.SOLN_DEBUG_OUTPUT_ON
1009
723
  """
1010
724
 
725
+ INVALID = _clientpb.INVALID_DEBUG_OUTPUT
1011
726
  SOLN_DEBUG_OUTPUT_OFF = _clientpb.SOLN_DEBUG_OUTPUT_OFF
1012
727
  SOLN_DEBUG_OUTPUT_ON = _clientpb.SOLN_DEBUG_OUTPUT_ON
1013
728
 
@@ -1031,6 +746,7 @@ class DebugOutputInteriorSurfaceData(_IntEnum):
1031
746
  >>> DebugOutputInteriorSurfaceData.SOLN_DEBUG_OUTPUT_INT_SURF_DATA_ON
1032
747
  """
1033
748
 
749
+ INVALID = _clientpb.INVALID_DEBUG_OUTPUT_INTERIOR_SURFACE_DATA
1034
750
  SOLN_DEBUG_OUTPUT_INT_SURF_DATA_OFF = _clientpb.SOLN_DEBUG_OUTPUT_INT_SURF_DATA_OFF
1035
751
  SOLN_DEBUG_OUTPUT_INT_SURF_DATA_ON = _clientpb.SOLN_DEBUG_OUTPUT_INT_SURF_DATA_ON
1036
752
 
@@ -1054,6 +770,7 @@ class MeshingMethod(_IntEnum):
1054
770
  >>> MeshingMethod.MESH_METHOD_AUTO
1055
771
  """
1056
772
 
773
+ INVALID = _clientpb.INVALID_MESHING_METHOD
1057
774
  MESH_METHOD_MANUAL = _clientpb.MESH_METHOD_MANUAL
1058
775
  MESH_METHOD_AUTO = _clientpb.MESH_METHOD_AUTO
1059
776
 
@@ -1081,34 +798,12 @@ class AllTet(_IntEnum):
1081
798
  >>> AllTet.ALL_TET_ON
1082
799
  """
1083
800
 
801
+ INVALID = _clientpb.INVALID_ALL_TET
1084
802
  ALL_TET_UNSET = _clientpb.ALL_TET_UNSET
1085
803
  ALL_TET_OFF = _clientpb.ALL_TET_OFF
1086
804
  ALL_TET_ON = _clientpb.ALL_TET_ON
1087
805
 
1088
806
 
1089
- class RelaxationMethod(_IntEnum):
1090
- """
1091
- Relaxation scheme for steady-state simulations or time implicit transient simulations.
1092
-
1093
- Attributes
1094
- ----------
1095
- IMPLICIT
1096
- Apply an implicit relaxation scheme.
1097
- EXPLICIT
1098
- Apply an explicit relaxation scheme.
1099
-
1100
-
1101
- Examples
1102
- --------
1103
- >>> from luminarycloud.params.enum import RelaxationMethod
1104
- >>> RelaxationMethod.IMPLICIT
1105
- >>> RelaxationMethod.EXPLICIT
1106
- """
1107
-
1108
- IMPLICIT = _clientpb.IMPLICIT
1109
- EXPLICIT = _clientpb.EXPLICIT
1110
-
1111
-
1112
807
  class ImplicitMethod(_IntEnum):
1113
808
  """
1114
809
  Scheme for implicit relaxation of the governing equations.
@@ -1125,40 +820,10 @@ class ImplicitMethod(_IntEnum):
1125
820
  >>> ImplicitMethod.BACKWARD_EULER
1126
821
  """
1127
822
 
823
+ INVALID = _clientpb.INVALID_IMPLICIT_METHOD
1128
824
  BACKWARD_EULER = _clientpb.BACKWARD_EULER
1129
825
 
1130
826
 
1131
- class LinearSolverType(_IntEnum):
1132
- """
1133
- Type of linear solver used for implicit relaxation.
1134
-
1135
- Attributes
1136
- ----------
1137
- GS
1138
- Gauss-Seidel iterative method.
1139
- GS_AMGX
1140
- Gauss-Seidel iterative method.
1141
- AMG_KRYLOV_AMGX
1142
- AMG + Krylov iterative method.
1143
- AMG_AMGX
1144
- AMG iterative method.
1145
-
1146
-
1147
- Examples
1148
- --------
1149
- >>> from luminarycloud.params.enum import LinearSolverType
1150
- >>> LinearSolverType.GS
1151
- >>> LinearSolverType.GS_AMGX
1152
- >>> LinearSolverType.AMG_KRYLOV_AMGX
1153
- >>> LinearSolverType.AMG_AMGX
1154
- """
1155
-
1156
- GS = _clientpb.GS
1157
- GS_AMGX = _clientpb.GS_AMGX
1158
- AMG_KRYLOV_AMGX = _clientpb.AMG_KRYLOV_AMGX
1159
- AMG_AMGX = _clientpb.AMG_AMGX
1160
-
1161
-
1162
827
  class LinsolAmgCycleType(_IntEnum):
1163
828
  """
1164
829
  AMG cycle type
@@ -1181,6 +846,7 @@ class LinsolAmgCycleType(_IntEnum):
1181
846
  >>> LinsolAmgCycleType.LINSOL_AMG_CYCLE_TYPE_F
1182
847
  """
1183
848
 
849
+ INVALID = _clientpb.INVALID_LINSOL_AMG_CYCLE_TYPE
1184
850
  LINSOL_AMG_CYCLE_TYPE_V = _clientpb.LINSOL_AMG_CYCLE_TYPE_V
1185
851
  LINSOL_AMG_CYCLE_TYPE_W = _clientpb.LINSOL_AMG_CYCLE_TYPE_W
1186
852
  LINSOL_AMG_CYCLE_TYPE_F = _clientpb.LINSOL_AMG_CYCLE_TYPE_F
@@ -1208,6 +874,7 @@ class LinsolAmgSmoother(_IntEnum):
1208
874
  >>> LinsolAmgSmoother.LINSOL_AMG_SMOOTHER_SYM_GS
1209
875
  """
1210
876
 
877
+ INVALID = _clientpb.INVALID_LINSOL_AMG_SMOOTHER
1211
878
  LINSOL_AMG_SMOOTHER_JACOBI = _clientpb.LINSOL_AMG_SMOOTHER_JACOBI
1212
879
  LINSOL_AMG_SMOOTHER_GS = _clientpb.LINSOL_AMG_SMOOTHER_GS
1213
880
  LINSOL_AMG_SMOOTHER_SYM_GS = _clientpb.LINSOL_AMG_SMOOTHER_SYM_GS
@@ -1235,6 +902,7 @@ class ExplicitMethod(_IntEnum):
1235
902
  >>> ExplicitMethod.FORWARD_EULER
1236
903
  """
1237
904
 
905
+ INVALID = _clientpb.INVALID_EXPLICIT_METHOD
1238
906
  RK_4 = _clientpb.RK_4
1239
907
  TVD_RK_3 = _clientpb.TVD_RK_3
1240
908
  FORWARD_EULER = _clientpb.FORWARD_EULER
@@ -1268,6 +936,7 @@ class SolutionControlsHeatPreset(_IntEnum):
1268
936
  >>> SolutionControlsHeatPreset.CUSTOM_SOLUTION_CONTROLS_HEAT
1269
937
  """
1270
938
 
939
+ INVALID = _clientpb.INVALID_SOLUTION_CONTROLS_HEAT_PRESET
1271
940
  UNSET_SOLUTION_CONTROLS_HEAT_PRESET = _clientpb.UNSET_SOLUTION_CONTROLS_HEAT_PRESET
1272
941
  DEFAULT_SOLUTION_CONTROLS_HEAT = _clientpb.DEFAULT_SOLUTION_CONTROLS_HEAT
1273
942
  INTERMEDIATE_SOLUTION_CONTROLS_HEAT = _clientpb.INTERMEDIATE_SOLUTION_CONTROLS_HEAT
@@ -1297,6 +966,7 @@ class AdjointSolutionMethod(_IntEnum):
1297
966
  >>> AdjointSolutionMethod.ADJOINT_METHOD_ALGORITHMIC
1298
967
  """
1299
968
 
969
+ INVALID = _clientpb.INVALID_ADJOINT_SOLUTION_METHOD
1300
970
  ADJOINT_METHOD_GMRES = _clientpb.ADJOINT_METHOD_GMRES
1301
971
  ADJOINT_METHOD_RICHARDSON = _clientpb.ADJOINT_METHOD_RICHARDSON
1302
972
  ADJOINT_METHOD_ALGORITHMIC = _clientpb.ADJOINT_METHOD_ALGORITHMIC
@@ -1331,6 +1001,7 @@ class GradientMethod(_IntEnum):
1331
1001
  >>> GradientMethod.NODAL_GRADIENT
1332
1002
  """
1333
1003
 
1004
+ INVALID = _clientpb.INVALID_GRADIENT_METHOD
1334
1005
  HLSQ = _clientpb.HLSQ
1335
1006
  WEIGHTED_LEAST_SQUARES = _clientpb.WEIGHTED_LEAST_SQUARES
1336
1007
  GREEN_GAUSS = _clientpb.GREEN_GAUSS
@@ -1357,6 +1028,7 @@ class GeometryFixes(_IntEnum):
1357
1028
  >>> GeometryFixes.GEOMETRY_FIXES_OFF
1358
1029
  """
1359
1030
 
1031
+ INVALID = _clientpb.INVALID_GEOMETRY_FIXES
1360
1032
  GEOMETRY_FIXES_ON = _clientpb.GEOMETRY_FIXES_ON
1361
1033
  GEOMETRY_FIXES_OFF = _clientpb.GEOMETRY_FIXES_OFF
1362
1034
 
@@ -1389,6 +1061,7 @@ class SpatialDiscretizationHeatPreset(_IntEnum):
1389
1061
  >>> SpatialDiscretizationHeatPreset.CUSTOM_SPATIAL_DISCRETIZATION_HEAT
1390
1062
  """
1391
1063
 
1064
+ INVALID = _clientpb.INVALID_SPATIAL_DISCRETIZATION_HEAT_PRESET
1392
1065
  UNSET_SPATIAL_DISCRETIZATION_HEAT_PRESET = _clientpb.UNSET_SPATIAL_DISCRETIZATION_HEAT_PRESET
1393
1066
  DEFAULT_SPATIAL_DISCRETIZATION_HEAT = _clientpb.DEFAULT_SPATIAL_DISCRETIZATION_HEAT
1394
1067
  CONSERVATIVE_SPATIAL_DISCRETIZATION_HEAT = _clientpb.CONSERVATIVE_SPATIAL_DISCRETIZATION_HEAT
@@ -1416,6 +1089,8 @@ class ProfileType(_IntEnum):
1416
1089
  1D radial profile normal to the Z direction.
1417
1090
  TIME
1418
1091
  Time varying profile.
1092
+ CARTESIAN_XY
1093
+ 2D profile in X and Y direction.
1419
1094
 
1420
1095
 
1421
1096
  Examples
@@ -1428,8 +1103,10 @@ class ProfileType(_IntEnum):
1428
1103
  >>> ProfileType.RADIAL_Y
1429
1104
  >>> ProfileType.RADIAL_Z
1430
1105
  >>> ProfileType.TIME
1106
+ >>> ProfileType.CARTESIAN_XY
1431
1107
  """
1432
1108
 
1109
+ INVALID = _clientpb.INVALID_PROFILE_TYPE
1433
1110
  CARTESIAN_X = _clientpb.CARTESIAN_X
1434
1111
  CARTESIAN_Y = _clientpb.CARTESIAN_Y
1435
1112
  CARTESIAN_Z = _clientpb.CARTESIAN_Z
@@ -1437,99 +1114,7 @@ class ProfileType(_IntEnum):
1437
1114
  RADIAL_Y = _clientpb.RADIAL_Y
1438
1115
  RADIAL_Z = _clientpb.RADIAL_Z
1439
1116
  TIME = _clientpb.TIME
1440
-
1441
-
1442
- class HeatPhysicalBoundary(_IntEnum):
1443
- """
1444
-
1445
-
1446
- Attributes
1447
- ----------
1448
- HEAT_BC_ISOTHERMAL
1449
- Fixed temperature.
1450
- HEAT_BC_HEAT_FLUX
1451
- Heat flux.
1452
- HEAT_BC_INTEGRATED_HEAT_FLUX
1453
- Integrated heat flux.
1454
- HEAT_BC_SYMMETRY
1455
- Symmetry.
1456
- HEAT_BC_CONVECTION
1457
- Convective heat transfer.
1458
-
1459
-
1460
- Examples
1461
- --------
1462
- >>> from luminarycloud.params.enum import HeatPhysicalBoundary
1463
- >>> HeatPhysicalBoundary.HEAT_BC_ISOTHERMAL
1464
- >>> HeatPhysicalBoundary.HEAT_BC_HEAT_FLUX
1465
- >>> HeatPhysicalBoundary.HEAT_BC_INTEGRATED_HEAT_FLUX
1466
- >>> HeatPhysicalBoundary.HEAT_BC_SYMMETRY
1467
- >>> HeatPhysicalBoundary.HEAT_BC_CONVECTION
1468
- """
1469
-
1470
- HEAT_BC_ISOTHERMAL = _clientpb.HEAT_BC_ISOTHERMAL
1471
- HEAT_BC_HEAT_FLUX = _clientpb.HEAT_BC_HEAT_FLUX
1472
- HEAT_BC_INTEGRATED_HEAT_FLUX = _clientpb.HEAT_BC_INTEGRATED_HEAT_FLUX
1473
- HEAT_BC_SYMMETRY = _clientpb.HEAT_BC_SYMMETRY
1474
- HEAT_BC_CONVECTION = _clientpb.HEAT_BC_CONVECTION
1475
-
1476
-
1477
- class InitializationType(_IntEnum):
1478
- """
1479
- Type of initial condition for the field variables.
1480
-
1481
- Attributes
1482
- ----------
1483
- UNIFORM_VALUES
1484
- Apply a uniform initial condition for all fields in space.
1485
- FARFIELD_VALUES
1486
- Initialize all fields uniformly in space using the values at the far-field boundary.
1487
- INITIALIZATION_POTENTIAL_FLOW
1488
- Initialize the velocity from an irrotational incompressible potential flow solution.
1489
- VERIFICATION_SOLUTION
1490
- Apply an initial condition corresponding to a predefined problem.
1491
- EXISTING_SOLUTION
1492
- Apply the starting values from an existing solution for the same mesh.
1493
-
1494
-
1495
- Examples
1496
- --------
1497
- >>> from luminarycloud.params.enum import InitializationType
1498
- >>> InitializationType.UNIFORM_VALUES
1499
- >>> InitializationType.FARFIELD_VALUES
1500
- >>> InitializationType.INITIALIZATION_POTENTIAL_FLOW
1501
- >>> InitializationType.VERIFICATION_SOLUTION
1502
- >>> InitializationType.EXISTING_SOLUTION
1503
- """
1504
-
1505
- UNIFORM_VALUES = _clientpb.UNIFORM_VALUES
1506
- FARFIELD_VALUES = _clientpb.FARFIELD_VALUES
1507
- INITIALIZATION_POTENTIAL_FLOW = _clientpb.INITIALIZATION_POTENTIAL_FLOW
1508
- VERIFICATION_SOLUTION = _clientpb.VERIFICATION_SOLUTION
1509
- EXISTING_SOLUTION = _clientpb.EXISTING_SOLUTION
1510
-
1511
-
1512
- class HeatSourceType(_IntEnum):
1513
- """
1514
- Heat source specification.
1515
-
1516
- Attributes
1517
- ----------
1518
- HEAT_SOURCE_TYPE_POWER
1519
- Specify heat source power in Watts.
1520
- HEAT_SOURCE_TYPE_POWER_PER_UNIT_OF_VOLUME
1521
- Specify heat source power in Watts per unit volume.
1522
-
1523
-
1524
- Examples
1525
- --------
1526
- >>> from luminarycloud.params.enum import HeatSourceType
1527
- >>> HeatSourceType.HEAT_SOURCE_TYPE_POWER
1528
- >>> HeatSourceType.HEAT_SOURCE_TYPE_POWER_PER_UNIT_OF_VOLUME
1529
- """
1530
-
1531
- HEAT_SOURCE_TYPE_POWER = _clientpb.HEAT_SOURCE_TYPE_POWER
1532
- HEAT_SOURCE_TYPE_POWER_PER_UNIT_OF_VOLUME = _clientpb.HEAT_SOURCE_TYPE_POWER_PER_UNIT_OF_VOLUME
1117
+ CARTESIAN_XY = _clientpb.CARTESIAN_XY
1533
1118
 
1534
1119
 
1535
1120
  class InterfaceType(_IntEnum):
@@ -1552,33 +1137,11 @@ class InterfaceType(_IntEnum):
1552
1137
  >>> InterfaceType.MIXING_PLANE_INTERFACE
1553
1138
  """
1554
1139
 
1140
+ INVALID = _clientpb.INVALID_INTERFACE_TYPE
1555
1141
  GENERAL_INTERFACE = _clientpb.GENERAL_INTERFACE
1556
1142
  MIXING_PLANE_INTERFACE = _clientpb.MIXING_PLANE_INTERFACE
1557
1143
 
1558
1144
 
1559
- class PeriodicBcType(_IntEnum):
1560
- """
1561
-
1562
-
1563
- Attributes
1564
- ----------
1565
- TRANSLATIONAL
1566
-
1567
- ROTATIONAL
1568
-
1569
-
1570
-
1571
- Examples
1572
- --------
1573
- >>> from luminarycloud.params.enum import PeriodicBcType
1574
- >>> PeriodicBcType.TRANSLATIONAL
1575
- >>> PeriodicBcType.ROTATIONAL
1576
- """
1577
-
1578
- TRANSLATIONAL = _clientpb.TRANSLATIONAL
1579
- ROTATIONAL = _clientpb.ROTATIONAL
1580
-
1581
-
1582
1145
  class FluidType(_IntEnum):
1583
1146
  """
1584
1147
  Fluid types available for use with the solver.
@@ -1601,6 +1164,7 @@ class FluidType(_IntEnum):
1601
1164
  >>> FluidType.VOF_FLUID
1602
1165
  """
1603
1166
 
1167
+ INVALID = _clientpb.INVALID_FLUID_TYPE
1604
1168
  SINGLE_PHASE = _clientpb.SINGLE_PHASE
1605
1169
  CAVITATING_FLUID = _clientpb.CAVITATING_FLUID
1606
1170
  VOF_FLUID = _clientpb.VOF_FLUID
@@ -1634,6 +1198,7 @@ class ViscousModel(_IntEnum):
1634
1198
  >>> ViscousModel.INVISCID
1635
1199
  """
1636
1200
 
1201
+ INVALID = _clientpb.INVALID_VISCOUS_MODEL
1637
1202
  RANS = _clientpb.RANS
1638
1203
  DES = _clientpb.DES
1639
1204
  LES = _clientpb.LES
@@ -1641,45 +1206,6 @@ class ViscousModel(_IntEnum):
1641
1206
  INVISCID = _clientpb.INVISCID
1642
1207
 
1643
1208
 
1644
- class DesFormulation(_IntEnum):
1645
- """
1646
- Select a Detached Eddy Simulation (DES) formulation.
1647
-
1648
- Attributes
1649
- ----------
1650
- DDES_VTM
1651
- Use the DDES formulation with the shear-layer-adapted LES length-scale.
1652
- DDES_VTM_SIGMA
1653
- DDES with shear-layer-adapted LES length-scale and Sigma LES model.
1654
- IDDES
1655
- Use the Improved Delayed Detached Eddy Simulation (DDES) formulation.
1656
- DDES
1657
- Use the delayed Detached Eddy Simulation (DDES) formulation.
1658
- DES97
1659
- Use the original Detached Eddy Simulation (DES) formulation.
1660
- ZDES
1661
- Use the Zonal Detached Eddy Simulation (ZDES) formulation.
1662
-
1663
-
1664
- Examples
1665
- --------
1666
- >>> from luminarycloud.params.enum import DesFormulation
1667
- >>> DesFormulation.DDES_VTM
1668
- >>> DesFormulation.DDES_VTM_SIGMA
1669
- >>> DesFormulation.IDDES
1670
- >>> DesFormulation.DDES
1671
- >>> DesFormulation.DES97
1672
- >>> DesFormulation.ZDES
1673
- """
1674
-
1675
- DDES_VTM = _clientpb.DDES_VTM
1676
- DDES_VTM_SIGMA = _clientpb.DDES_VTM_SIGMA
1677
- IDDES = _clientpb.IDDES
1678
- DDES = _clientpb.DDES
1679
- DES97 = _clientpb.DES97
1680
- ZDES = _clientpb.ZDES
1681
-
1682
-
1683
1209
  class RansRegion(_IntEnum):
1684
1210
  """
1685
1211
  Select a region where RANS behavior should be enforced.
@@ -1699,49 +1225,11 @@ class RansRegion(_IntEnum):
1699
1225
  >>> RansRegion.OUTSIDE
1700
1226
  """
1701
1227
 
1228
+ INVALID = _clientpb.INVALID_RANS_REGION
1702
1229
  INSIDE = _clientpb.INSIDE
1703
1230
  OUTSIDE = _clientpb.OUTSIDE
1704
1231
 
1705
1232
 
1706
- class SubGridScaleModel(_IntEnum):
1707
- """
1708
- Sub-grid scale models available for Large Eddy Simulation (LES).
1709
-
1710
- Attributes
1711
- ----------
1712
- NONE
1713
- No sub-grid scale model.
1714
- SMAGORINSKY
1715
- Smagorinsky eddy viscosity model.
1716
- VREMAN
1717
- Vreman eddy viscosity model.
1718
- WALE
1719
- Wall adapting local eddy (WALE) viscosity model.
1720
- SIGMA
1721
- Sigma eddy viscosity model.
1722
- AMD
1723
- AMD eddy viscosity model.
1724
-
1725
-
1726
- Examples
1727
- --------
1728
- >>> from luminarycloud.params.enum import SubGridScaleModel
1729
- >>> SubGridScaleModel.NONE
1730
- >>> SubGridScaleModel.SMAGORINSKY
1731
- >>> SubGridScaleModel.VREMAN
1732
- >>> SubGridScaleModel.WALE
1733
- >>> SubGridScaleModel.SIGMA
1734
- >>> SubGridScaleModel.AMD
1735
- """
1736
-
1737
- NONE = _clientpb.NONE
1738
- SMAGORINSKY = _clientpb.SMAGORINSKY
1739
- VREMAN = _clientpb.VREMAN
1740
- WALE = _clientpb.WALE
1741
- SIGMA = _clientpb.SIGMA
1742
- AMD = _clientpb.AMD
1743
-
1744
-
1745
1233
  class TransitionModel(_IntEnum):
1746
1234
  """
1747
1235
  Laminar-turbulent transition models available for Reynolds-averaged Navier-Stokes (RANS).
@@ -1770,6 +1258,7 @@ class TransitionModel(_IntEnum):
1770
1258
  >>> TransitionModel.AFT_2019
1771
1259
  """
1772
1260
 
1261
+ INVALID = _clientpb.INVALID_TRANSITION_MODEL
1773
1262
  NO_TRANSITION = _clientpb.NO_TRANSITION
1774
1263
  GAMMA_2015 = _clientpb.GAMMA_2015
1775
1264
  GAMMA_RE_THETA_2009 = _clientpb.GAMMA_RE_THETA_2009
@@ -1795,33 +1284,11 @@ class TransitionModelCrossFlow(_IntEnum):
1795
1284
  >>> TransitionModelCrossFlow.TRANSITION_MODEL_CROSS_FLOW_ON
1796
1285
  """
1797
1286
 
1287
+ INVALID = _clientpb.INVALID_TRANSITION_MODEL_CROSS_FLOW
1798
1288
  TRANSITION_MODEL_CROSS_FLOW_OFF = _clientpb.TRANSITION_MODEL_CROSS_FLOW_OFF
1799
1289
  TRANSITION_MODEL_CROSS_FLOW_ON = _clientpb.TRANSITION_MODEL_CROSS_FLOW_ON
1800
1290
 
1801
1291
 
1802
- class TurbulenceModel(_IntEnum):
1803
- """
1804
- Turbulence models available for Reynolds-averaged Navier-Stokes (RANS) or Detached Eddy Simulation (DES).
1805
-
1806
- Attributes
1807
- ----------
1808
- SPALART_ALLMARAS
1809
- 'Standard' Spalart-Allmaras one-equation turbulence model.
1810
- KOMEGA_SST
1811
- SST 2003m model.
1812
-
1813
-
1814
- Examples
1815
- --------
1816
- >>> from luminarycloud.params.enum import TurbulenceModel
1817
- >>> TurbulenceModel.SPALART_ALLMARAS
1818
- >>> TurbulenceModel.KOMEGA_SST
1819
- """
1820
-
1821
- SPALART_ALLMARAS = _clientpb.SPALART_ALLMARAS
1822
- KOMEGA_SST = _clientpb.KOMEGA_SST
1823
-
1824
-
1825
1292
  class QcrSa(_IntEnum):
1826
1293
  """
1827
1294
  Modification of the traditional linear Boussinesq relation for the Spalart-Allmaras turbulence model via the quadratic constitutive relation (QCR).
@@ -1841,6 +1308,7 @@ class QcrSa(_IntEnum):
1841
1308
  >>> QcrSa.QCR2000
1842
1309
  """
1843
1310
 
1311
+ INVALID = _clientpb.INVALID_QCR_SA
1844
1312
  QCR_OFF = _clientpb.QCR_OFF
1845
1313
  QCR2000 = _clientpb.QCR2000
1846
1314
 
@@ -1864,33 +1332,11 @@ class RotationCorrectionSa(_IntEnum):
1864
1332
  >>> RotationCorrectionSa.ROTATION_CORRECTION_ON
1865
1333
  """
1866
1334
 
1335
+ INVALID = _clientpb.INVALID_ROTATION_CORRECTION_SA
1867
1336
  ROTATION_CORRECTION_OFF = _clientpb.ROTATION_CORRECTION_OFF
1868
1337
  ROTATION_CORRECTION_ON = _clientpb.ROTATION_CORRECTION_ON
1869
1338
 
1870
1339
 
1871
- class TurbulenceModelConstants(_IntEnum):
1872
- """
1873
- Apply default constants for the RANS turbulence model or choose to customize.
1874
-
1875
- Attributes
1876
- ----------
1877
- DEFAULT_TURB_CONSTANTS
1878
- Use default turbulence model constants.
1879
- CUSTOM_TURB_CONSTANTS
1880
- Enter custom turbulence model constants.
1881
-
1882
-
1883
- Examples
1884
- --------
1885
- >>> from luminarycloud.params.enum import TurbulenceModelConstants
1886
- >>> TurbulenceModelConstants.DEFAULT_TURB_CONSTANTS
1887
- >>> TurbulenceModelConstants.CUSTOM_TURB_CONSTANTS
1888
- """
1889
-
1890
- DEFAULT_TURB_CONSTANTS = _clientpb.DEFAULT_TURB_CONSTANTS
1891
- CUSTOM_TURB_CONSTANTS = _clientpb.CUSTOM_TURB_CONSTANTS
1892
-
1893
-
1894
1340
  class QcrSst(_IntEnum):
1895
1341
  """
1896
1342
  Modification of the traditional linear Boussinesq relation for the SST turbulence model via the quadratic constitutive relation (QCR).
@@ -1910,33 +1356,11 @@ class QcrSst(_IntEnum):
1910
1356
  >>> QcrSst.SST_QCR2000
1911
1357
  """
1912
1358
 
1359
+ INVALID = _clientpb.INVALID_QCR_SST
1913
1360
  SST_QCR_OFF = _clientpb.SST_QCR_OFF
1914
1361
  SST_QCR2000 = _clientpb.SST_QCR2000
1915
1362
 
1916
1363
 
1917
- class PseudoTimeStepMethod(_IntEnum):
1918
- """
1919
- Method for obtaining the pseudo time step in a steady-state simulation or for the inner iterations of the dual time stepping method.
1920
-
1921
- Attributes
1922
- ----------
1923
- CFL_BASED
1924
- Compute a pseudo time step from a Courant-Friedrichs-Lewy (CFL) number.
1925
- FIXED_PSEUDO_TIME_STEP
1926
- Apply a fixed pseudo time step.
1927
-
1928
-
1929
- Examples
1930
- --------
1931
- >>> from luminarycloud.params.enum import PseudoTimeStepMethod
1932
- >>> PseudoTimeStepMethod.CFL_BASED
1933
- >>> PseudoTimeStepMethod.FIXED_PSEUDO_TIME_STEP
1934
- """
1935
-
1936
- CFL_BASED = _clientpb.CFL_BASED
1937
- FIXED_PSEUDO_TIME_STEP = _clientpb.FIXED_PSEUDO_TIME_STEP
1938
-
1939
-
1940
1364
  class LocalTimeStepping(_IntEnum):
1941
1365
  """
1942
1366
  Compute local time steps in each control volume to accelerate convergence
@@ -1958,6 +1382,7 @@ class LocalTimeStepping(_IntEnum):
1958
1382
  >>> LocalTimeStepping.LOCAL_TIME_STEPPING_OFF
1959
1383
  """
1960
1384
 
1385
+ INVALID = _clientpb.INVALID_LOCAL_TIME_STEPPING
1961
1386
  LOCAL_TIME_STEPPING_ON = _clientpb.LOCAL_TIME_STEPPING_ON
1962
1387
  LOCAL_TIME_STEPPING_OFF = _clientpb.LOCAL_TIME_STEPPING_OFF
1963
1388
 
@@ -1978,32 +1403,10 @@ class JacobianUpdateMethod(_IntEnum):
1978
1403
  >>> JacobianUpdateMethod.EXPLICIT_INTERVAL_AND_WARMUP
1979
1404
  """
1980
1405
 
1406
+ INVALID = _clientpb.INVALID_JACOBIAN_UPDATE_METHOD
1981
1407
  EXPLICIT_INTERVAL_AND_WARMUP = _clientpb.EXPLICIT_INTERVAL_AND_WARMUP
1982
1408
 
1983
1409
 
1984
- class RobustStartup(_IntEnum):
1985
- """
1986
- Applies a robust startup process during the initial transients of a simulation. Applicable to steady problems only.
1987
-
1988
- Attributes
1989
- ----------
1990
- ROBUST_STARTUP_ON
1991
- Enable robust startup mode.
1992
- ROBUST_STARTUP_OFF
1993
- Disable robust startup mode.
1994
-
1995
-
1996
- Examples
1997
- --------
1998
- >>> from luminarycloud.params.enum import RobustStartup
1999
- >>> RobustStartup.ROBUST_STARTUP_ON
2000
- >>> RobustStartup.ROBUST_STARTUP_OFF
2001
- """
2002
-
2003
- ROBUST_STARTUP_ON = _clientpb.ROBUST_STARTUP_ON
2004
- ROBUST_STARTUP_OFF = _clientpb.ROBUST_STARTUP_OFF
2005
-
2006
-
2007
1410
  class SolutionControlsFluidPreset(_IntEnum):
2008
1411
  """
2009
1412
  Select suggested control settings or allow a custom choice. In general, assume a trade-off between speed and robustness (i.e. the ability to converge).
@@ -2032,6 +1435,7 @@ class SolutionControlsFluidPreset(_IntEnum):
2032
1435
  >>> SolutionControlsFluidPreset.CUSTOM_SOLUTION_CONTROLS_FLUID
2033
1436
  """
2034
1437
 
1438
+ INVALID = _clientpb.INVALID_SOLUTION_CONTROLS_FLUID_PRESET
2035
1439
  UNSET_SOLUTION_CONTROLS_FLUID_PRESET = _clientpb.UNSET_SOLUTION_CONTROLS_FLUID_PRESET
2036
1440
  DEFAULT_SOLUTION_CONTROLS_FLUID = _clientpb.DEFAULT_SOLUTION_CONTROLS_FLUID
2037
1441
  INTERMEDIATE_SOLUTION_CONTROLS_FLUID = _clientpb.INTERMEDIATE_SOLUTION_CONTROLS_FLUID
@@ -2039,37 +1443,6 @@ class SolutionControlsFluidPreset(_IntEnum):
2039
1443
  CUSTOM_SOLUTION_CONTROLS_FLUID = _clientpb.CUSTOM_SOLUTION_CONTROLS_FLUID
2040
1444
 
2041
1445
 
2042
- class ConvectiveSchemesDensityBased(_IntEnum):
2043
- """
2044
- Type of scheme for discretizing the convective terms of the fluid equations.
2045
-
2046
- Attributes
2047
- ----------
2048
- ROE
2049
- Flux Difference Splitting scheme.
2050
- LD2
2051
- Low-Dissipation Low-Dispersion (LD2) scheme.
2052
- EC2
2053
- Entropy-Stable discretization.
2054
- RHIE_CHOW
2055
- Rhie-Chow method.
2056
-
2057
-
2058
- Examples
2059
- --------
2060
- >>> from luminarycloud.params.enum import ConvectiveSchemesDensityBased
2061
- >>> ConvectiveSchemesDensityBased.ROE
2062
- >>> ConvectiveSchemesDensityBased.LD2
2063
- >>> ConvectiveSchemesDensityBased.EC2
2064
- >>> ConvectiveSchemesDensityBased.RHIE_CHOW
2065
- """
2066
-
2067
- ROE = _clientpb.ROE
2068
- LD2 = _clientpb.LD2
2069
- EC2 = _clientpb.EC2
2070
- RHIE_CHOW = _clientpb.RHIE_CHOW
2071
-
2072
-
2073
1446
  class Preconditioning(_IntEnum):
2074
1447
  """
2075
1448
  Apply low-speed preconditioning to obtain Mach number-independent solutions for ideal gases.
@@ -2089,6 +1462,7 @@ class Preconditioning(_IntEnum):
2089
1462
  >>> Preconditioning.PRECONDITIONING_OFF
2090
1463
  """
2091
1464
 
1465
+ INVALID = _clientpb.INVALID_PRECONDITIONING
2092
1466
  PRECONDITIONING_ON = _clientpb.PRECONDITIONING_ON
2093
1467
  PRECONDITIONING_OFF = _clientpb.PRECONDITIONING_OFF
2094
1468
 
@@ -2112,6 +1486,7 @@ class ArtificialViscosityModel(_IntEnum):
2112
1486
  >>> ArtificialViscosityModel.LAD
2113
1487
  """
2114
1488
 
1489
+ INVALID = _clientpb.INVALID_ARTIFICIAL_VISCOSITY_MODEL
2115
1490
  NO_MODEL = _clientpb.NO_MODEL
2116
1491
  LAD = _clientpb.LAD
2117
1492
 
@@ -2138,34 +1513,12 @@ class SkewSymmetricFormulation(_IntEnum):
2138
1513
  >>> SkewSymmetricFormulation.KUYA
2139
1514
  """
2140
1515
 
1516
+ INVALID = _clientpb.INVALID_SKEW_SYMMETRIC_FORMULATION
2141
1517
  CHANDRASEKHAR_EC2 = _clientpb.CHANDRASEKHAR_EC2
2142
1518
  CHANDRASEKHAR_EC1 = _clientpb.CHANDRASEKHAR_EC1
2143
1519
  KUYA = _clientpb.KUYA
2144
1520
 
2145
1521
 
2146
- class UpwindSchemeOrder(_IntEnum):
2147
- """
2148
- Spatial order of accuracy of the convective scheme used for the fluid equations.
2149
-
2150
- Attributes
2151
- ----------
2152
- SECOND
2153
- Second-order accuracy.
2154
- FIRST
2155
- First-order accuracy.
2156
-
2157
-
2158
- Examples
2159
- --------
2160
- >>> from luminarycloud.params.enum import UpwindSchemeOrder
2161
- >>> UpwindSchemeOrder.SECOND
2162
- >>> UpwindSchemeOrder.FIRST
2163
- """
2164
-
2165
- SECOND = _clientpb.SECOND
2166
- FIRST = _clientpb.FIRST
2167
-
2168
-
2169
1522
  class RobustDissipation(_IntEnum):
2170
1523
  """
2171
1524
  Use a form of dissipation that improves robustness but that may reduce accuracy.
@@ -2185,6 +1538,7 @@ class RobustDissipation(_IntEnum):
2185
1538
  >>> RobustDissipation.ROBUST_DISS_ON
2186
1539
  """
2187
1540
 
1541
+ INVALID = _clientpb.INVALID_ROBUST_DISSIPATION
2188
1542
  ROBUST_DISS_OFF = _clientpb.ROBUST_DISS_OFF
2189
1543
  ROBUST_DISS_ON = _clientpb.ROBUST_DISS_ON
2190
1544
 
@@ -2219,6 +1573,7 @@ class Limiter(_IntEnum):
2219
1573
  >>> Limiter.VENKATAKRISHNAN_CV
2220
1574
  """
2221
1575
 
1576
+ INVALID = _clientpb.INVALID_LIMITER
2222
1577
  NO_LIMITER = _clientpb.NO_LIMITER
2223
1578
  INVARIANT_VENKATAKRISHNAN_CV = _clientpb.INVARIANT_VENKATAKRISHNAN_CV
2224
1579
  VAN_ALBADA_FACE = _clientpb.VAN_ALBADA_FACE
@@ -2253,6 +1608,7 @@ class SpatialDiscretizationFluidPreset(_IntEnum):
2253
1608
  >>> SpatialDiscretizationFluidPreset.CUSTOM_SPATIAL_DISCRETIZATION_FLUID
2254
1609
  """
2255
1610
 
1611
+ INVALID = _clientpb.INVALID_SPATIAL_DISCRETIZATION_FLUID_PRESET
2256
1612
  UNSET_SPATIAL_DISCRETIZATION_FLUID_PRESET = _clientpb.UNSET_SPATIAL_DISCRETIZATION_FLUID_PRESET
2257
1613
  DEFAULT_SPATIAL_DISCRETIZATION_FLUID = _clientpb.DEFAULT_SPATIAL_DISCRETIZATION_FLUID
2258
1614
  CONSERVATIVE_SPATIAL_DISCRETIZATION_FLUID = _clientpb.CONSERVATIVE_SPATIAL_DISCRETIZATION_FLUID
@@ -2262,95 +1618,6 @@ class SpatialDiscretizationFluidPreset(_IntEnum):
2262
1618
  CUSTOM_SPATIAL_DISCRETIZATION_FLUID = _clientpb.CUSTOM_SPATIAL_DISCRETIZATION_FLUID
2263
1619
 
2264
1620
 
2265
- class PhysicalBoundary(_IntEnum):
2266
- """
2267
-
2268
-
2269
- Attributes
2270
- ----------
2271
- WALL
2272
- Solid wall boundary condition.
2273
- INLET
2274
- Inlet boundary condition.
2275
- OUTLET
2276
- Outlet boundary condition.
2277
- SYMMETRY
2278
- Symmetry boundary condition.
2279
- FARFIELD
2280
- Far-field boundary condition.
2281
- OVERSET
2282
- Overset boundary condition.
2283
-
2284
-
2285
- Examples
2286
- --------
2287
- >>> from luminarycloud.params.enum import PhysicalBoundary
2288
- >>> PhysicalBoundary.WALL
2289
- >>> PhysicalBoundary.INLET
2290
- >>> PhysicalBoundary.OUTLET
2291
- >>> PhysicalBoundary.SYMMETRY
2292
- >>> PhysicalBoundary.FARFIELD
2293
- >>> PhysicalBoundary.OVERSET
2294
- """
2295
-
2296
- WALL = _clientpb.WALL
2297
- INLET = _clientpb.INLET
2298
- OUTLET = _clientpb.OUTLET
2299
- SYMMETRY = _clientpb.SYMMETRY
2300
- FARFIELD = _clientpb.FARFIELD
2301
- OVERSET = _clientpb.OVERSET
2302
-
2303
-
2304
- class WallMomentum(_IntEnum):
2305
- """
2306
- Condition applied to the momentum equations at a solid wall boundary.
2307
-
2308
- Attributes
2309
- ----------
2310
- NO_SLIP
2311
- Apply a no-slip condition at the wall surface.
2312
- SLIP
2313
- Apply a slip (flow tangency) condition at the wall surface.
2314
- WALL_MODEL
2315
- Apply a wall model at the wall surface.
2316
-
2317
-
2318
- Examples
2319
- --------
2320
- >>> from luminarycloud.params.enum import WallMomentum
2321
- >>> WallMomentum.NO_SLIP
2322
- >>> WallMomentum.SLIP
2323
- >>> WallMomentum.WALL_MODEL
2324
- """
2325
-
2326
- NO_SLIP = _clientpb.NO_SLIP
2327
- SLIP = _clientpb.SLIP
2328
- WALL_MODEL = _clientpb.WALL_MODEL
2329
-
2330
-
2331
- class WallEnergy(_IntEnum):
2332
- """
2333
- Condition applied to the energy equation at a solid wall boundary.
2334
-
2335
- Attributes
2336
- ----------
2337
- FIXED_HEAT_FLUX
2338
- Apply a fixed heat flux at the wall surface.
2339
- FIXED_TEMPERATURE
2340
- Apply a fixed temperature at the wall surface.
2341
-
2342
-
2343
- Examples
2344
- --------
2345
- >>> from luminarycloud.params.enum import WallEnergy
2346
- >>> WallEnergy.FIXED_HEAT_FLUX
2347
- >>> WallEnergy.FIXED_TEMPERATURE
2348
- """
2349
-
2350
- FIXED_HEAT_FLUX = _clientpb.FIXED_HEAT_FLUX
2351
- FIXED_TEMPERATURE = _clientpb.FIXED_TEMPERATURE
2352
-
2353
-
2354
1621
  class InletEnergy(_IntEnum):
2355
1622
  """
2356
1623
  Method of defining the inlet energy conditions.
@@ -2367,6 +1634,7 @@ class InletEnergy(_IntEnum):
2367
1634
  >>> InletEnergy.TOTAL_TEMPERATURE_INLET
2368
1635
  """
2369
1636
 
1637
+ INVALID = _clientpb.INVALID_INLET_ENERGY
2370
1638
  TOTAL_TEMPERATURE_INLET = _clientpb.TOTAL_TEMPERATURE_INLET
2371
1639
 
2372
1640
 
@@ -2392,6 +1660,7 @@ class TurbulenceSpecificationSpalartAllmaras(_IntEnum):
2392
1660
  >>> TurbulenceSpecificationSpalartAllmaras.BC_SA_VARIABLE
2393
1661
  """
2394
1662
 
1663
+ INVALID = _clientpb.INVALID_TURBULENCE_SPECIFICATION_SPALART_ALLMARAS
2395
1664
  TURBULENT_VISCOSITY_RATIO_SA = _clientpb.TURBULENT_VISCOSITY_RATIO_SA
2396
1665
  TURBULENT_VISCOSITY_SA = _clientpb.TURBULENT_VISCOSITY_SA
2397
1666
  BC_SA_VARIABLE = _clientpb.BC_SA_VARIABLE
@@ -2419,6 +1688,7 @@ class TurbulenceSpecificationKomega(_IntEnum):
2419
1688
  >>> TurbulenceSpecificationKomega.BC_KOMEGA_VARIABLES
2420
1689
  """
2421
1690
 
1691
+ INVALID = _clientpb.INVALID_TURBULENCE_SPECIFICATION_KOMEGA
2422
1692
  BC_TURBULENT_VISCOSITY_RATIO_AND_INTENSITY_KOMEGA = (
2423
1693
  _clientpb.BC_TURBULENT_VISCOSITY_RATIO_AND_INTENSITY_KOMEGA
2424
1694
  )
@@ -2428,45 +1698,6 @@ class TurbulenceSpecificationKomega(_IntEnum):
2428
1698
  BC_KOMEGA_VARIABLES = _clientpb.BC_KOMEGA_VARIABLES
2429
1699
 
2430
1700
 
2431
- class InletMomentum(_IntEnum):
2432
- """
2433
- Method of defining the inlet momentum conditions.
2434
-
2435
- Attributes
2436
- ----------
2437
- TOTAL_PRESSURE_INLET
2438
- Specify total pressure.
2439
- MASS_FLOW_INLET
2440
- Specify mass flow rate.
2441
- VELOCITY_INLET
2442
- Specify the velocity magnitude.
2443
- VELOCITY_COMPONENTS_INLET
2444
- Specify the components of the velocity vector.
2445
- MACH_INLET
2446
- Specify the inlet Mach number and static conditions. Note that for subsonic flow the static pressure is not used.
2447
- FAN_CURVE_INLET
2448
- Specify the relation between the fan pressure rise and the volume flow rate.
2449
-
2450
-
2451
- Examples
2452
- --------
2453
- >>> from luminarycloud.params.enum import InletMomentum
2454
- >>> InletMomentum.TOTAL_PRESSURE_INLET
2455
- >>> InletMomentum.MASS_FLOW_INLET
2456
- >>> InletMomentum.VELOCITY_INLET
2457
- >>> InletMomentum.VELOCITY_COMPONENTS_INLET
2458
- >>> InletMomentum.MACH_INLET
2459
- >>> InletMomentum.FAN_CURVE_INLET
2460
- """
2461
-
2462
- TOTAL_PRESSURE_INLET = _clientpb.TOTAL_PRESSURE_INLET
2463
- MASS_FLOW_INLET = _clientpb.MASS_FLOW_INLET
2464
- VELOCITY_INLET = _clientpb.VELOCITY_INLET
2465
- VELOCITY_COMPONENTS_INLET = _clientpb.VELOCITY_COMPONENTS_INLET
2466
- MACH_INLET = _clientpb.MACH_INLET
2467
- FAN_CURVE_INLET = _clientpb.FAN_CURVE_INLET
2468
-
2469
-
2470
1701
  class DirectionSpecification(_IntEnum):
2471
1702
  """
2472
1703
  Method of defining the flow direction at the inlet.
@@ -2486,44 +1717,11 @@ class DirectionSpecification(_IntEnum):
2486
1717
  >>> DirectionSpecification.DIRECTION_VECTOR
2487
1718
  """
2488
1719
 
1720
+ INVALID = _clientpb.INVALID_DIRECTION_SPECIFICATION
2489
1721
  NORMAL_TO_BOUNDARY = _clientpb.NORMAL_TO_BOUNDARY
2490
1722
  DIRECTION_VECTOR = _clientpb.DIRECTION_VECTOR
2491
1723
 
2492
1724
 
2493
- class OutletStrategy(_IntEnum):
2494
- """
2495
- Outlet strategy.
2496
-
2497
- Attributes
2498
- ----------
2499
- OUTLET_PRESSURE
2500
- Specify an outlet static pressure.
2501
- OUTLET_TARGET_MASS_FLOW_RATE
2502
- Specify a target mass flow rate. Warning: this strategy will not work if
2503
- the flow becomes choked or if it is fixed by any other flow constraint (e.g. a velocity inlet).
2504
- OUTLET_TARGET_CORRECTED_MASS_FLOW_RATE
2505
- Specify a target mass flow rate corrected for given reference temperature and pressure
2506
- (&#856;m<sub>corr</sub> = &#856;m <sup>&radic; T<sub>0</sub></sup> &frasl; <sub>&radic;T<sub>ref</sub></sub>
2507
- <sup>P<sub>ref</sub></sup> &frasl; <sub>P<sub>0</sub></sub>).
2508
- FAN_CURVE_OUTLET
2509
- Specify the relation between the fan pressure rise and the volume flow rate.
2510
-
2511
-
2512
- Examples
2513
- --------
2514
- >>> from luminarycloud.params.enum import OutletStrategy
2515
- >>> OutletStrategy.OUTLET_PRESSURE
2516
- >>> OutletStrategy.OUTLET_TARGET_MASS_FLOW_RATE
2517
- >>> OutletStrategy.OUTLET_TARGET_CORRECTED_MASS_FLOW_RATE
2518
- >>> OutletStrategy.FAN_CURVE_OUTLET
2519
- """
2520
-
2521
- OUTLET_PRESSURE = _clientpb.OUTLET_PRESSURE
2522
- OUTLET_TARGET_MASS_FLOW_RATE = _clientpb.OUTLET_TARGET_MASS_FLOW_RATE
2523
- OUTLET_TARGET_CORRECTED_MASS_FLOW_RATE = _clientpb.OUTLET_TARGET_CORRECTED_MASS_FLOW_RATE
2524
- FAN_CURVE_OUTLET = _clientpb.FAN_CURVE_OUTLET
2525
-
2526
-
2527
1725
  class OutletPressureConstraint(_IntEnum):
2528
1726
  """
2529
1727
  Mode of imposing pressure at the outlet.
@@ -2546,6 +1744,7 @@ class OutletPressureConstraint(_IntEnum):
2546
1744
  >>> OutletPressureConstraint.OUTLET_AVERAGE_CONSTRAINT
2547
1745
  """
2548
1746
 
1747
+ INVALID = _clientpb.INVALID_OUTLET_PRESSURE_CONSTRAINT
2549
1748
  OUTLET_LOCAL_CONSTRAINT = _clientpb.OUTLET_LOCAL_CONSTRAINT
2550
1749
  OUTLET_AVERAGE_CONSTRAINT = _clientpb.OUTLET_AVERAGE_CONSTRAINT
2551
1750
 
@@ -2569,6 +1768,7 @@ class FarfieldMomentum(_IntEnum):
2569
1768
  >>> FarfieldMomentum.FARFIELD_VELOCITY_MAGNITUDE
2570
1769
  """
2571
1770
 
1771
+ INVALID = _clientpb.INVALID_FARFIELD_MOMENTUM
2572
1772
  FARFIELD_MACH_NUMBER = _clientpb.FARFIELD_MACH_NUMBER
2573
1773
  FARFIELD_VELOCITY_MAGNITUDE = _clientpb.FARFIELD_VELOCITY_MAGNITUDE
2574
1774
 
@@ -2592,6 +1792,7 @@ class FarFieldFlowDirectionSpecification(_IntEnum):
2592
1792
  >>> FarFieldFlowDirectionSpecification.FARFIELD_ANGLES
2593
1793
  """
2594
1794
 
1795
+ INVALID = _clientpb.INVALID_FAR_FIELD_FLOW_DIRECTION_SPECIFICATION
2595
1796
  FARFIELD_DIRECTION = _clientpb.FARFIELD_DIRECTION
2596
1797
  FARFIELD_ANGLES = _clientpb.FARFIELD_ANGLES
2597
1798
 
@@ -2621,6 +1822,7 @@ class TurbulentVariableInitializationTypeSa(_IntEnum):
2621
1822
  >>> TurbulentVariableInitializationTypeSa.INIT_FARFIELD_VALUES_SA
2622
1823
  """
2623
1824
 
1825
+ INVALID = _clientpb.INVALID_TURBULENT_VARIABLE_INITIALIZATION_TYPE_SA
2624
1826
  INIT_TURBULENT_VISCOSITY_RATIO_SA = _clientpb.INIT_TURBULENT_VISCOSITY_RATIO_SA
2625
1827
  INIT_TURBULENT_VISCOSITY_SA = _clientpb.INIT_TURBULENT_VISCOSITY_SA
2626
1828
  INIT_SA_VARIABLE = _clientpb.INIT_SA_VARIABLE
@@ -2652,6 +1854,7 @@ class TurbulentVariableInitializationTypeKomega(_IntEnum):
2652
1854
  >>> TurbulentVariableInitializationTypeKomega.INIT_FARFIELD_VALUES_KOMEGA
2653
1855
  """
2654
1856
 
1857
+ INVALID = _clientpb.INVALID_TURBULENT_VARIABLE_INITIALIZATION_TYPE_KOMEGA
2655
1858
  INIT_TURBULENT_VISCOSITY_RATIO_AND_INTENSITY_KOMEGA = (
2656
1859
  _clientpb.INIT_TURBULENT_VISCOSITY_RATIO_AND_INTENSITY_KOMEGA
2657
1860
  )
@@ -2681,6 +1884,7 @@ class PotentialFlowPressureInitialization(_IntEnum):
2681
1884
  >>> PotentialFlowPressureInitialization.INITIALIZATION_POTENTIAL_FLOW_PRESSURE_ON
2682
1885
  """
2683
1886
 
1887
+ INVALID = _clientpb.INVALID_POTENTIAL_FLOW_PRESSURE_INITIALIZATION
2684
1888
  INITIALIZATION_POTENTIAL_FLOW_PRESSURE_OFF = (
2685
1889
  _clientpb.INITIALIZATION_POTENTIAL_FLOW_PRESSURE_OFF
2686
1890
  )
@@ -2733,6 +1937,7 @@ class VerificationSolutions(_IntEnum):
2733
1937
  >>> VerificationSolutions.CHECK_FLUX_SYMMETRY
2734
1938
  """
2735
1939
 
1940
+ INVALID = _clientpb.INVALID_VERIFICATION_SOLUTIONS
2736
1941
  TAYLOR_GREEN_VORTEX = _clientpb.TAYLOR_GREEN_VORTEX
2737
1942
  NS_MMS = _clientpb.NS_MMS
2738
1943
  EULER_MMS = _clientpb.EULER_MMS
@@ -2746,64 +1951,6 @@ class VerificationSolutions(_IntEnum):
2746
1951
  CHECK_FLUX_SYMMETRY = _clientpb.CHECK_FLUX_SYMMETRY
2747
1952
 
2748
1953
 
2749
- class PhysicalBehaviorModel(_IntEnum):
2750
- """
2751
- Defines the physical behavior type.
2752
-
2753
- Attributes
2754
- ----------
2755
- ACTUATOR_DISK_MODEL
2756
- Behavior inputs associated with actuator disks
2757
- ACTUATOR_LINE_MODEL
2758
- Behavior inputs associated with actuator lines
2759
- SOURCE_POINTS_MODEL
2760
- Behavior inputs associated with source points
2761
-
2762
-
2763
- Examples
2764
- --------
2765
- >>> from luminarycloud.params.enum import PhysicalBehaviorModel
2766
- >>> PhysicalBehaviorModel.ACTUATOR_DISK_MODEL
2767
- >>> PhysicalBehaviorModel.ACTUATOR_LINE_MODEL
2768
- >>> PhysicalBehaviorModel.SOURCE_POINTS_MODEL
2769
- """
2770
-
2771
- ACTUATOR_DISK_MODEL = _clientpb.ACTUATOR_DISK_MODEL
2772
- ACTUATOR_LINE_MODEL = _clientpb.ACTUATOR_LINE_MODEL
2773
- SOURCE_POINTS_MODEL = _clientpb.SOURCE_POINTS_MODEL
2774
-
2775
-
2776
- class ActuatorDiskModel(_IntEnum):
2777
- """
2778
- Defines the physics behavior of the actuator disk.
2779
-
2780
- Attributes
2781
- ----------
2782
- ACTUATOR_DISK_UNIFORM_THRUST
2783
- Applies a uniform force at all locations on the disk
2784
- ACTUATOR_DISK_RADIAL_DISTRIBUTION
2785
- Thrust, torque, and radial force profiles
2786
- ACTUATOR_DISK_BLADE_ELEMENT
2787
- Uses tables of airfoil aerodynamic data to model the effect of rotors and propellers
2788
- FAN_CURVE_INTERNAL
2789
- Specify the relation between the fan pressure rise and the volume flow rate.
2790
-
2791
-
2792
- Examples
2793
- --------
2794
- >>> from luminarycloud.params.enum import ActuatorDiskModel
2795
- >>> ActuatorDiskModel.ACTUATOR_DISK_UNIFORM_THRUST
2796
- >>> ActuatorDiskModel.ACTUATOR_DISK_RADIAL_DISTRIBUTION
2797
- >>> ActuatorDiskModel.ACTUATOR_DISK_BLADE_ELEMENT
2798
- >>> ActuatorDiskModel.FAN_CURVE_INTERNAL
2799
- """
2800
-
2801
- ACTUATOR_DISK_UNIFORM_THRUST = _clientpb.ACTUATOR_DISK_UNIFORM_THRUST
2802
- ACTUATOR_DISK_RADIAL_DISTRIBUTION = _clientpb.ACTUATOR_DISK_RADIAL_DISTRIBUTION
2803
- ACTUATOR_DISK_BLADE_ELEMENT = _clientpb.ACTUATOR_DISK_BLADE_ELEMENT
2804
- FAN_CURVE_INTERNAL = _clientpb.FAN_CURVE_INTERNAL
2805
-
2806
-
2807
1954
  class ActuatorDiskBemStrategy(_IntEnum):
2808
1955
  """
2809
1956
  Defines how the power of the propeller is specified in the blade element model
@@ -2823,52 +1970,11 @@ class ActuatorDiskBemStrategy(_IntEnum):
2823
1970
  >>> ActuatorDiskBemStrategy.BEM_TARGET_THRUST
2824
1971
  """
2825
1972
 
1973
+ INVALID = _clientpb.INVALID_ACTUATOR_DISK_BEM_STRATEGY
2826
1974
  BEM_ROTATION_RATE = _clientpb.BEM_ROTATION_RATE
2827
1975
  BEM_TARGET_THRUST = _clientpb.BEM_TARGET_THRUST
2828
1976
 
2829
1977
 
2830
- class ActuatorLineModel(_IntEnum):
2831
- """
2832
- Defines the physics behavior of the actuator line.
2833
-
2834
- Attributes
2835
- ----------
2836
- ACTUATOR_LINE_BLADE_ELEMENT
2837
- Uses tables of airfoil aerodynamic data to model the effect of rotors and propellers
2838
-
2839
-
2840
- Examples
2841
- --------
2842
- >>> from luminarycloud.params.enum import ActuatorLineModel
2843
- >>> ActuatorLineModel.ACTUATOR_LINE_BLADE_ELEMENT
2844
- """
2845
-
2846
- ACTUATOR_LINE_BLADE_ELEMENT = _clientpb.ACTUATOR_LINE_BLADE_ELEMENT
2847
-
2848
-
2849
- class ParticleSourceModel(_IntEnum):
2850
- """
2851
- Defines the behavior of the general source particles.
2852
-
2853
- Attributes
2854
- ----------
2855
- GENERAL_MASS_SOURCE
2856
- Injects material into the solver at particle locations
2857
- GENERAL_ACCELERATION_SOURCE
2858
- Applies an acceleration at particle locations
2859
-
2860
-
2861
- Examples
2862
- --------
2863
- >>> from luminarycloud.params.enum import ParticleSourceModel
2864
- >>> ParticleSourceModel.GENERAL_MASS_SOURCE
2865
- >>> ParticleSourceModel.GENERAL_ACCELERATION_SOURCE
2866
- """
2867
-
2868
- GENERAL_MASS_SOURCE = _clientpb.GENERAL_MASS_SOURCE
2869
- GENERAL_ACCELERATION_SOURCE = _clientpb.GENERAL_ACCELERATION_SOURCE
2870
-
2871
-
2872
1978
  class CavitationModel(_IntEnum):
2873
1979
  """
2874
1980
  Cavitation models available for simulating flow with cavitation.
@@ -2885,6 +1991,7 @@ class CavitationModel(_IntEnum):
2885
1991
  >>> CavitationModel.SAUER_SCHNERR
2886
1992
  """
2887
1993
 
1994
+ INVALID = _clientpb.INVALID_CAVITATION_MODEL
2888
1995
  SAUER_SCHNERR = _clientpb.SAUER_SCHNERR
2889
1996
 
2890
1997
 
@@ -2904,6 +2011,7 @@ class PorousModelType(_IntEnum):
2904
2011
  >>> PorousModelType.DARCY_FORCHHEIMER
2905
2012
  """
2906
2013
 
2014
+ INVALID = _clientpb.INVALID_POROUS_MODEL_TYPE
2907
2015
  DARCY_FORCHHEIMER = _clientpb.DARCY_FORCHHEIMER
2908
2016
 
2909
2017
 
@@ -2926,5 +2034,6 @@ class MpCouplingLinSolCoupling(_IntEnum):
2926
2034
  >>> MpCouplingLinSolCoupling.MP_COUPLING_LIN_SOL_COUPLING_OFF
2927
2035
  """
2928
2036
 
2037
+ INVALID = _clientpb.INVALID_MP_COUPLING_LIN_SOL_COUPLING
2929
2038
  MP_COUPLING_LIN_SOL_COUPLING_ON = _clientpb.MP_COUPLING_LIN_SOL_COUPLING_ON
2930
2039
  MP_COUPLING_LIN_SOL_COUPLING_OFF = _clientpb.MP_COUPLING_LIN_SOL_COUPLING_OFF