cs_restart_default.h File Reference

#include "cs_defs.h"
#include "cs_field.h"
#include "cs_map.h"
#include "cs_restart.h"

Include dependency graph for cs_restart_default.h:

Go to the source code of this file.

Enumerations
enum	cs_restart_file_t {   CS_RESTART_DISABLED = -1 , CS_RESTART_MAIN = 0 , CS_RESTART_AUXILIARY = 1 , CS_RESTART_RAD_TRANSFER = 2 ,   CS_RESTART_LAGR = 3 , CS_RESTART_LAGR_STAT = 4 , CS_RESTART_1D_WALL_THERMAL = 5 , CS_RESTART_LES_INFLOW = 6 ,   CS_RESTART_IBM = 7 , CS_RESTART_N_RESTART_FILES = 8 }

Functions
void	cs_restart_read_field_info (cs_restart_t *r, cs_map_name_to_id_t **old_field_map)
	Read field metadata from checkpoint. More...
void	cs_restart_write_field_info (cs_restart_t *r)
	Write field metadata to main checkpoint. More...
void	cs_restart_read_variables (cs_restart_t *r, const cs_map_name_to_id_t *old_field_map, int t_id_flag, int read_flag[])
	Read variables from checkpoint. More...
void	cs_restart_write_variables (cs_restart_t *r, int t_id_flag, int write_flag[])
	Write variables to checkpoint. More...
void	cs_restart_read_notebook_variables (cs_restart_t *r)
	Read notebook parameters from main checkpoint. More...
void	cs_restart_write_notebook_variables (cs_restart_t *r)
	Write notebook parameters to main checkpoint. More...
void	cs_restart_read_linked_fields (cs_restart_t *r, const cs_map_name_to_id_t *old_field_map, const char *key, int read_flag[])
	Read fields depending on others from checkpoint. More...
int	cs_restart_write_linked_fields (cs_restart_t *r, const char *key, int write_flag[])
	Write fields depending on others to checkpoint. More...
void	cs_restart_read_bc_coeffs (cs_restart_t *r)
	Read boundary condition coefficients for all fields from checkpoint. More...
void	cs_restart_write_bc_coeffs (cs_restart_t *r)
	Write boundary condition coefficients for all fields to checkpoint. More...
int	cs_restart_read_field_vals (cs_restart_t *r, int f_id, int t_id)
	Read field values from checkpoint. More...
void	cs_restart_write_field_vals (cs_restart_t *r, int f_id, int t_id)
	Write field values to checkpoint. More...
void	cs_restart_read_time_step_info (cs_restart_t *r)
	Read restart time step info. More...
void	cs_restart_write_fields (cs_restart_t *r, cs_restart_file_t r_id)
	Loop over all fields and save them in the restart file which id is passed in argument if it matches their "restart_file" key value. More...
void	cs_restart_read_fields (cs_restart_t *r, cs_restart_file_t r_id)
	Loop over all fields and read them in the restart file which id is passed in argument if it matches their "restart_file" key value. More...
void	cs_restart_set_auxiliary_field_options (void)
	Set restart file values for fields when those values cannot be determined at field definition time. More...
void	cs_restart_initialize_fields_read_status (void)
	Initialize fields read status array. More...
void	cs_restart_finalize_fields_read_status (void)
	Finalize fields read status array. More...
int	cs_restart_get_field_read_status (const int f_id)
	Get checkpoint read status for a field based on its id. More...

Enumeration Type Documentation

cs_restart_file_t

enum cs_restart_file_t

Restart file ids

Enumerator
CS_RESTART_DISABLED	no values to save
CS_RESTART_MAIN	save values in main restart file
CS_RESTART_AUXILIARY	save values in auxiliary restart file
CS_RESTART_RAD_TRANSFER	save values in radiative transfer restart file
CS_RESTART_LAGR	save values in lagrangian restart file
CS_RESTART_LAGR_STAT	save values in restart file for lagrangian statistics
CS_RESTART_1D_WALL_THERMAL	save values in 1D wall thermal restart file
CS_RESTART_LES_INFLOW	save values in LES inflow restart file
CS_RESTART_IBM	save values in porous restart file
CS_RESTART_N_RESTART_FILES	Number of types of restart file

Function Documentation

cs_restart_finalize_fields_read_status()

void cs_restart_finalize_fields_read_status

(

void

)

Finalize fields read status array.

cs_restart_get_field_read_status()

int cs_restart_get_field_read_status

(

const int

f_id

)

Get checkpoint read status for a field based on its id.

Parameters

[in]

f_id

field id

Returns

0 if field read action failed, 1 otherwise

cs_restart_initialize_fields_read_status()

void cs_restart_initialize_fields_read_status

(

void

)

Initialize fields read status array.

cs_restart_read_bc_coeffs()

void cs_restart_read_bc_coeffs

(

cs_restart_t *

r

)

Read boundary condition coefficients for all fields from checkpoint.

Parameters

[in,out]

r

associated restart file pointer

cs_restart_read_field_info()

void cs_restart_read_field_info	(	cs_restart_t *	r,
		cs_map_name_to_id_t **	old_field_map
	)

Read field metadata from checkpoint.

Old ids associated to each field are determined for future use. Note that when reading legacy files (code_saturne version 3.3 and below), the old id will actually be the old scalar id (-1 for others).

Parameters

[in,out]	r	associated restart file pointer
[out]	old_field_map	name to id map of fields in restart file

cs_restart_read_field_vals()

int cs_restart_read_field_vals	(	cs_restart_t *	r,
		int	f_id,
		int	t_id
	)

Read field values from checkpoint.

If the values are not found using the default rules based on the field's name, its name itself, or a "restart_rename" keyed string value, an old name may be used for compatibility with older files. For cell-based fields, the old name base is appended automatically with "_ce_phase01", except for scalars, where the name uses a different scheme, based on "scalaire_ce_%04" % s_num;

Parameters

[in,out]	r	associated restart file pointer
[in]	f_id	field id
[in]	t_id	time id (0 for current, 1 for previous, ...)

Returns

CS_RESTART_SUCCESS in case of success, CS_RESTART_ERR_... otherwise

cs_restart_read_fields()

void cs_restart_read_fields	(	cs_restart_t *	r,
		cs_restart_file_t	r_id
	)

Loop over all fields and read them in the restart file which id is passed in argument if it matches their "restart_file" key value.

Parameters

[in,out]	r	associated restart file pointer
[in]	r_id	value of the key "restart_file"

cs_restart_read_linked_fields()

void cs_restart_read_linked_fields	(	cs_restart_t *	r,
		const cs_map_name_to_id_t *	old_field_map,
		const char *	key,
		int	read_flag[]
	)

Read fields depending on others from checkpoint.

Old ids associate to each field are determined for future use. Note that when reading legacy files (code_saturne version 3.3 and below), the old id will actually be the old scalar id (-1 for others).

Parameters

[in,out]	r	associated restart file pointer
[in]	old_field_map	name to id map of fields in restart file
[in]	key	key for field association
[in,out]	read_flag	optional flag to track fields read, or nullptr; set to sum of 2^time_id for fields read, -1 for fields failed to read (size: n_fields)

cs_restart_read_notebook_variables()

void cs_restart_read_notebook_variables

(

cs_restart_t *

r

)

Read notebook parameters from main checkpoint.

Parameters

[in,out]

r

associated restart file pointer

cs_restart_read_time_step_info()

void cs_restart_read_time_step_info

(

cs_restart_t *

r

)

Read restart time step info.

Parameters

[in,out]

r

associated restart file pointer

cs_restart_read_variables()

void cs_restart_read_variables	(	cs_restart_t *	r,
		const cs_map_name_to_id_t *	old_field_map,
		int	t_id_flag,
		int	read_flag[]
	)

Read variables from checkpoint.

Parameters

[in,out]	r	associated restart file pointer
[in]	old_field_map	name to id map of fields in restart file
[in]	t_id_flag	-1: all time values; 0: current values; > 0: previous values
[in,out]	read_flag	optional flag to track fields read, or nullptr; set to sum of 2^time_id for fields read (size: n_fields)

cs_restart_set_auxiliary_field_options()

void cs_restart_set_auxiliary_field_options

(

void

)

Set restart file values for fields when those values cannot be determined at field definition time.

This is needed when the need for restart data depends on various combinations of settings.

cs_restart_write_bc_coeffs()

void cs_restart_write_bc_coeffs

(

cs_restart_t *

r

)

Write boundary condition coefficients for all fields to checkpoint.

Parameters

[in,out]

r

associated restart file pointer

cs_restart_write_field_info()

void cs_restart_write_field_info

(

cs_restart_t *

r

)

Write field metadata to main checkpoint.

Parameters

[in,out]

r

associated restart file pointer

cs_restart_write_field_vals()

void cs_restart_write_field_vals	(	cs_restart_t *	r,
		int	f_id,
		int	t_id
	)

Write field values to checkpoint.

Parameters

[in,out]	r	associated restart file pointer
[in]	f_id	field id
[in]	t_id	time id (0 for current, 1 for previous, ...)

cs_restart_write_fields()

void cs_restart_write_fields	(	cs_restart_t *	r,
		cs_restart_file_t	r_id
	)

Loop over all fields and save them in the restart file which id is passed in argument if it matches their "restart_file" key value.

Parameters

[in,out]	r	associated restart file pointer
[in]	r_id	value of the key "restart_file"

cs_restart_write_linked_fields()

int cs_restart_write_linked_fields	(	cs_restart_t *	r,
		const char *	key,
		int	write_flag[]
	)

Write fields depending on others to checkpoint.

Parameters

[in,out]	r	associated restart file pointer
[in]	key	key for field association
[in,out]	write_flag	optional flag to track fields written, or nullptr; set to sum of 2^time_id for fields written (size: n_fields)

Returns

number of fields written

cs_restart_write_notebook_variables()

void cs_restart_write_notebook_variables

(

cs_restart_t *

r

)

Write notebook parameters to main checkpoint.

Parameters

[in,out]

r

associated restart file pointer

cs_restart_write_variables()

void cs_restart_write_variables	(	cs_restart_t *	r,
		int	t_id_flag,
		int	write_flag[]
	)

Write variables to checkpoint.

Parameters

[in,out]	r	associated restart file pointer
[in]	t_id_flag	-1: all time values; 0: current values; > 0: previous values
[in,out]	write_flag	optional flag to track fields written, or nullptr; set to sum of 2^time_id for fields written (size: n_fields)