cs_log_iteration.h File Reference

#include "cs_base.h"
#include "cs_mesh_location.h"
#include "cs_time_step.h"

Include dependency graph for cs_log_iteration.h:

Go to the source code of this file.

Functions
void	cs_log_iteration_destroy_all (void)
	Free arrays possible used by logging of array statistics. More...
void	cs_log_iteration (void)
	Log field and other array statistics for the current time step. More...
void	cs_log_equation_convergence_info_write (void)
	Default function for equation convergence log info. More...
void	cs_log_iteration_set_automatic (int n)
	Set adaptive interval for "per time step" logging information. More...
void	cs_log_iteration_set_interval (int n)
	Set interval for "per time step" logging information. More...
void	cs_log_iteration_set_active (void)
	Activate or deactivate default log for current iteration. More...
void	cs_log_iteration_add_array (const char *name, const char *category, const cs_mesh_location_type_t loc_id, bool is_intensive, int dim, const cs_real_t val[])
	Add or update array not saved as permanent field to iteration log. More...
void	cs_log_iteration_clipping (const char *name, int dim, cs_lnum_t n_clip_min, cs_lnum_t n_clip_max, const cs_real_t min_pre_clip[], const cs_real_t max_pre_clip[])
	Add or update clipping info for a given array. More...
void	cs_log_iteration_clipping_field (int f_id, cs_lnum_t n_clip_min, cs_lnum_t n_clip_max, const cs_real_t min_pre_clip[], const cs_real_t max_pre_clip[], cs_lnum_t n_clip_min_comp[], cs_lnum_t n_clip_max_comp[])
	Add or update clipping info for a field. More...
void	cs_log_iteration_prepare (void)
	Initialize structures used for logging for new iteration. More...
void	cs_log_iteration_l2residual (void)
	Log L2 time residual for variable fields. More...
void	cs_log_iteration_log_setup (void)
	Print default log per iteration options to setup.log. More...

Function Documentation

cs_log_equation_convergence_info_write()

void cs_log_equation_convergence_info_write

(

void

)

Default function for equation convergence log info.

cs_log_iteration()

void cs_log_iteration

(

void

)

Log field and other array statistics for the current time step.

cs_log_iteration_add_array()

void cs_log_iteration_add_array	(	const char *	name,
		const char *	category,
		const cs_mesh_location_type_t	loc_id,
		bool	is_intensive,
		int	dim,
		const cs_real_t	val[]
	)

Add or update array not saved as permanent field to iteration log.

Parameters

[in]	name	array name
[in]	category	category name
[in]	loc_id	associated mesh location id
[in]	is_intensive	are the matching values intensive ?
[in]	dim	associated dimension (interleaved)
[in]	val	associated values

cs_log_iteration_clipping()

void cs_log_iteration_clipping	(	const char *	name,
		int	dim,
		cs_lnum_t	n_clip_min,
		cs_lnum_t	n_clip_max,
		const cs_real_t	min_pre_clip[],
		const cs_real_t	max_pre_clip[]
	)

Add or update clipping info for a given array.

Parameters

[in]	name	field or array name
[in]	dim	associated dimension
[in]	n_clip_min	number of local clippings to minimum value
[in]	n_clip_max	number of local clippings to maximum value
[in]	min_pre_clip	minimum values prior to clipping
[in]	max_pre_clip	maximum values prior to clipping

cs_log_iteration_clipping_field()

void cs_log_iteration_clipping_field	(	int	f_id,
		cs_lnum_t	n_clip_min,
		cs_lnum_t	n_clip_max,
		const cs_real_t	min_pre_clip[],
		const cs_real_t	max_pre_clip[],
		cs_lnum_t	n_clip_min_comp[],
		cs_lnum_t	n_clip_max_comp[]
	)

Add or update clipping info for a field.

Parameters

[in]	f_id	associated field id
[in]	n_clip_min	number of local clippings to minimum value
[in]	n_clip_max	number of local clippings to maximum value
[in]	min_pre_clip	minimum values prior to clipping
[in]	max_pre_clip	maximum values prior to clipping
[in]	n_clip_min_comp	number of clip min by component
[in]	n_clip_max_comp	number of clip max by component

cs_log_iteration_destroy_all()

void cs_log_iteration_destroy_all

(

void

)

Free arrays possible used by logging of array statistics.

cs_log_iteration_l2residual()

void cs_log_iteration_l2residual

(

void

)

Log L2 time residual for variable fields.

cs_log_iteration_log_setup()

void cs_log_iteration_log_setup

(

void

)

Print default log per iteration options to setup.log.

cs_log_iteration_prepare()

void cs_log_iteration_prepare

(

void

)

Initialize structures used for logging for new iteration.

cs_log_iteration_set_active()

void cs_log_iteration_set_active

(

void

)

Activate or deactivate default log for current iteration.

cs_log_iteration_set_automatic()

void cs_log_iteration_set_automatic

(

int

n

)

Set adaptive interval for "per time step" logging information.

Logging will also occur:

• Each time step for the first n absolute or restarted time steps.
• Every 5 time steps between n and 5.n time steps.
• Every 10 time steps between 5.n and 10.n time steps.
• Every 50 time steps between 10.n and 50.n time steps.
• Every 100 time steps between 50.n and 100.n time steps.
• ...
• At the last time step
  
  "),

Parameters

[in]

n

base interval for output.

cs_log_iteration_set_interval()

void cs_log_iteration_set_interval

(

int

n

)

Set interval for "per time step" logging information.

Logging will also occur for the 10 first time steps, as well as the last one.

Parameters

[in]

n

interval between 2 output time steps.