Log field and other array statistics at relevant time steps. More...
#include "cs_defs.h"#include <assert.h>#include <math.h>#include <stdarg.h>#include <stdio.h>#include <stdlib.h>#include <string.h>#include "bft_mem.h"#include "bft_printf.h"#include "cs_array_reduce.h"#include "cs_base.h"#include "cs_blas.h"#include "cs_ctwr.h"#include "cs_fan.h"#include "cs_field.h"#include "cs_field_pointer.h"#include "cs_function.h"#include "cs_log.h"#include "cs_map.h"#include "cs_mesh.h"#include "cs_mesh_location.h"#include "cs_notebook.h"#include "cs_parall.h"#include "cs_parameters.h"#include "cs_physical_model.h"#include "cs_prototypes.h"#include "cs_range_set.h"#include "cs_time_moment.h"#include "cs_time_plot.h"#include "cs_time_step.h"#include "cs_lagr_stat.h"#include "cs_lagr_log.h"#include "fvm_convert_array.h"#include "cs_log_iteration.h"Functions | |
| void | cs_log_iteration_destroy_all (void) |
| Free arrays possible used by logging of array statistics. | |
| void | cs_log_iteration (void) |
| Log field and other array statistics for the current time step. | |
| void | cs_log_equation_convergence_info_write (void) |
| Default function for equation convergence log info. | |
| void | cs_log_iteration_set_automatic (int n) |
| Set adaptive interval for "per time step" logging information. | |
| void | cs_log_iteration_set_interval (int n) |
| Set interval for "per time step" logging information. | |
| void | cs_log_iteration_set_active (void) |
| Activate or deactivate default log for current iteration. | |
| 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. | |
| 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. | |
| 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. | |
| void | cs_log_iteration_prepare (void) |
| Initialize structures used for logging for new iteration. | |
| void | cs_log_iteration_l2residual (void) |
| Log L2 time residual for variable fields. | |
| void | cs_log_iteration_log_setup (void) |
| Print default log per iteration options to setup.log. | |
Log field and other array statistics at relevant time steps.
| void cs_log_equation_convergence_info_write | ( | void | ) |
Default function for equation convergence log info.
| void cs_log_iteration | ( | void | ) |
Log field and other array statistics for the current time step.
| 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.
| [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 |
| 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.
| [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 |
| 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.
| [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 |
| void cs_log_iteration_destroy_all | ( | void | ) |
Free arrays possible used by logging of array statistics.
| void cs_log_iteration_l2residual | ( | void | ) |
Log L2 time residual for variable fields.
| void cs_log_iteration_log_setup | ( | void | ) |
Print default log per iteration options to setup.log.
| void cs_log_iteration_prepare | ( | void | ) |
Initialize structures used for logging for new iteration.
| void cs_log_iteration_set_active | ( | void | ) |
Activate or deactivate default log for current iteration.
| void cs_log_iteration_set_automatic | ( | int | n | ) |
Set adaptive interval for "per time step" logging information.
Logging will also occur:
| [in] | n | base interval for output. |
| 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.
| [in] | n | interval between 2 output time steps. |