My Project
programmer's documentation
Functions
cs_log_iteration.h File Reference
#include "fvm_nodal.h"
#include "fvm_writer.h"
#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_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_l2residual (void)
 Log L2 time residual for every variable fields. More...
 

Function Documentation

◆ 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]namearray name
[in]categorycategory name
[in]loc_idassociated mesh location id
[in]is_intensiveare the matching values intensive ?
[in]dimassociated dimension (interleaved)
[in]valassociated 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]namefield or array name
[in]dimassociated dimension
[in]n_clip_minnumber of local clippings to minimum value
[in]n_clip_maxnumber of local clippings to maximum value
[in]min_pre_clipminimum values prior to clipping
[in]max_pre_clipmaximum 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_idassociated field id
[in]n_clip_minnumber of local clippings to minimum value
[in]n_clip_maxnumber of local clippings to maximum value
[in]min_pre_clipminimum values prior to clipping
[in]max_pre_clipmaximum values prior to clipping
[in]n_clip_min_compnumber of clip min by component
[in]n_clip_max_compnumber 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_l2residual()

void cs_log_l2residual ( void  )

Log L2 time residual for every variable fields.