champ_don_base

Inherits from: field_base

Basic class for data fields (not calculated), p.e. physics properties.

champ_don_lu

Inherits from: champ_don_base

Field to read a data field (values located at the center of the cells) in a file.

Parameters:

dom (type: string) Name of the domain.
nb_comp (type: int) Number of field components.
file (type: string) Name of the file. This file has the following format: nb_val_lues -> Number of values readen in th file Xi Yi Zi -> Coordinates readen in the file Ui Vi Wi -> Value of the field

champ_fonc_fonction_txyz_morceaux

Inherits from: champ_don_base

Field defined by analytical functions in each sub-domaine. On each zone, the value is defined as a function of x,y,z,t and of scalar value taken from a parameter field. This values is associated to the variable 'val' in the expression.

Parameters:

problem_name (type: string) Name of the problem.
inco (type: string) Name of the field (for example: temperature).
nb_comp (type: int) Number of field components.
data (type: bloc_lecture) { Defaut val_def sous_domaine_1 val_1 ... sous_domaine_i val_i } By default, the value val_def is assigned to the field. It takes the sous_domaine_i identifier Sous_Domaine (sub_area) type object function, val_i. Sous_Domaine (sub_area) type objects must have been previously defined if the operator wishes to use a champ_fonc_fonction_txyz_morceaux type object.

champ_fonc_interp

Inherits from: champ_don_base

Field that is interpolated from a distant domain via MEDCoupling (remapper).

Parameters:

nom_champ (type: string) Name of the field (for example: temperature).
pb_loc (type: string) Name of the local problem.
pb_dist (type: string) Name of the distant problem.
[dom_loc] (type: string) Name of the local domain.
[dom_dist] (type: string) Name of the distant domain.
[default_value] (type: string) Name of the distant domain.
nature (type: string) Nature of the field (knowledge from MEDCoupling is required; IntensiveMaximum, IntensiveConservation, ...).
[use_overlapdec] (type: string) Nature of the field (knowledge from MEDCoupling is required; IntensiveMaximum, IntensiveConservation, ...).

champ_fonc_reprise

Inherits from: champ_don_base

This field is used to read a data field in a save file (.xyz or .sauv) at a specified time. It is very useful, for example, to run a thermohydraulic calculation with velocity initial condition read into a save file from a previous hydraulic calculation.

Parameters:

[format] (type: string into ['binaire', 'formatte', 'xyz', 'single_hdf', 'pdi']) Type of file (the file format). If xyz format is activated, the .xyz file from the previous calculation will be given for filename, and if formatte or binaire is choosen, the .sauv file of the previous calculation will be specified for filename. In the case of a parallel calculation, if the mesh partition does not changed between the previous calculation and the next one, the binaire format should be preferred, because is faster than the xyz format. If pdi is used, the same constraints/advantages as binaire apply, but it produces one (HDF5) file per node on the filesystem instead of having one file per processor. The single_hdf format is still supported but is obsolete, the PDI format is recommended.
filename (type: string) Name of the save file.
pb_name (type: string) Name of the problem.
champ (type: string) Name of the problem unknown. It may also be the temporal average of a problem unknown (like moyenne_vitesse, moyenne_temperature,...)
[fonction] (type: fonction_champ_reprise) Optional keyword to apply a function on the field being read in the save file (e.g. to read a temperature field in Celsius units and convert it for the calculation on Kelvin units, you will use: fonction 1 273.+val )
temps | time (type: string) Time of the saved field in the save file or last_time. If you give the keyword last_time instead, the last time saved in the save file will be used.

champ_fonc_t

Inherits from: champ_don_base

Field that is constant in space and is a function of time.

Parameters:

val (type: list of str) Values of field components (time dependant functions).

champ_init_canal_sinal

Inherits from: champ_don_base

For a parabolic profile on U velocity with an unpredictable disturbance on V and W and a sinusoidal disturbance on V velocity.

Parameters:

dim (type: int) Number of field components.
bloc (type: bloc_lec_champ_init_canal_sinal) Parameters for the class champ_init_canal_sinal.

champ_morceaux

Inherits from: champ_don_base

Field defined by subfields on a list of subdomains. Each field must be defined on the whole domain.

Parameters:

problem_name (type: string) Name of the problem.
data (type: bloc_lecture) { Defaut field_def sous_domaine_1 field_1 ... sous_domaine_i field_i } By default, the field field_def is assigned to the field. It takes the sous_domaine_i identifier Sous_Domaine (sub_area) type object field, field_i. Sous_Domaine (sub_area) type objects must have been previously defined if the operator wishes to use a champ_morceaux type object.

champ_parametrique

Inherits from: champ_don_base

Parametric field

Parameters:

fichier (type: string) Filename where fields are read

champ_som_lu_vdf

Inherits from: champ_don_base

Keyword to read in a file values located at the nodes of a mesh in VDF discretization.

Parameters:

domain_name (type: string) Name of the domain.
dim (type: int) Value of the dimension of the field.
tolerance (type: float) Value of the tolerance to check the coordinates of the nodes.
file (type: string) name of the file This file has the following format: Xi Yi Zi -> Coordinates of the node Ui Vi Wi -> Value of the field on this node Xi+1 Yi+1 Zi+1 -> Next point Ui+1 Vi+1 Zi+1 -> Next value ...

champ_som_lu_vef

Inherits from: champ_don_base

Keyword to read in a file values located at the nodes of a mesh in VEF discretization.

Parameters:

domain_name (type: string) Name of the domain.
dim (type: int) Value of the dimension of the field.
tolerance (type: float) Value of the tolerance to check the coordinates of the nodes.
file (type: string) Name of the file. This file has the following format: Xi Yi Zi -> Coordinates of the node Ui Vi Wi -> Value of the field on this node Xi+1 Yi+1 Zi+1 -> Next point Ui+1 Vi+1 Zi+1 -> Next value ...

field_func_txyz

Synonyms: champ_fonc_txyz

Inherits from: champ_don_base

Field defined by analytical functions. It makes it possible the definition of a field that depends on the time and the space.

Parameters:

dom (type: string) Name of domain of calculation
val (type: list of str) List of functions on (t,x,y,z).

field_func_xyz

Synonyms: champ_fonc_xyz

Inherits from: champ_don_base

Field defined by analytical functions. It makes it possible the definition of a field that depends on (x,y,z).

Parameters:

dom (type: string) Name of domain of calculation.
val (type: list of str) List of functions on (x,y,z).

init_par_partie

Inherits from: champ_don_base

ne marche que pour n_comp=1

Parameters:

n_comp (type: int into [1]) not_set
val1 (type: float) not_set
val2 (type: float) not_set
val3 (type: float) not_set

tayl_green

Inherits from: champ_don_base

Class Tayl_green.

Parameters:

dim (type: int) Dimension.

uniform_field

Synonyms: champ_uniforme

Inherits from: champ_don_base

Field that is constant in space and stationary.

Parameters:

val (type: list of float) Values of field components.