Constant Variables

The variables defined here are used globally in the code. If these variables are modified, the code behaves differently.

These are the constants known by Antares

Constants.KNOWN_CONSTANTS = {'1j': '1j', 'Rgaz': '287.053', 'gamma': '1.4', 'pi': 'pi', 'shape': 'instant.shape'}

The following variables are the default coordinate names in Antares. If a variable name is included in KNOWN_COORDINATES, then the variable will be considered as a mesh coordinate, except otherwise stated in a specific file reader.

Constants.KNOWN_COORDINATES = [['x', 'y', 'z'], ['x', 'y', 'Z'], ['x', 'Y', 'z'], ['x', 'Y', 'Z'], ['X', 'y', 'z'], ['X', 'y', 'Z'], ['X', 'Y', 'z'], ['X', 'Y', 'Z'], ['CoordinateX', 'CoordinateY', 'CoordinateZ']]
Constants.LOCATIONS = ['node', 'cell']

Global Variables

Coordinates

GlobalVar.coordinates = ['x', 'y', 'z']

This variable defines the default coordinate names. The first coordinate is, by default, the rotation axis (when needed).

This variable can be modified explicitely with the following function.

antares.core.GlobalVar.set_default_name(var, value)

Set default variable name to value.

Parameters
  • var (string in ['coordinates', 'base', 'zone', 'instant']) – variable name.

  • value (list of str, or string) – new default name.

GlobalVar.cartesian_coordinates = ['x', 'y', 'z']

This variable defines the default cartesian coordinate names (same as GlobalVar.coordinates).

GlobalVar.cylindrical_coordinates = ['x', 'r', 'theta']

This variable defines the default cylindrical coordinate names.

This variable can be modified explicitely with the following function.

antares.core.GlobalVar.set_default_cylindrical_coordinates(coord_names)

Set default GlobalVar.cylindrical_coordinates to coord_names.

Parameters

coord_names (list of str) – new default names of coordinates.

Default names

GlobalVar.base_name = '0000'
GlobalVar.zone_name = '0000'
GlobalVar.instant_name = '0000'

These variables can be modified explicitely with the following function.

antares.core.GlobalVar.set_default_name(var, value)

Set default variable name to value.

Parameters
  • var (string in ['coordinates', 'base', 'zone', 'instant']) – variable name.

  • value (list of str, or string) – new default name.