9.0
general documentation
Loading...
Searching...
No Matches
cs_runaway_check.cpp File Reference

Runaway (diverging) computation detection. More...

#include "base/cs_defs.h"
#include <assert.h>
#include <math.h>
#include <stdarg.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "bft/bft_mem.h"
#include "bft/bft_printf.h"
#include "base/cs_base.h"
#include "base/cs_field.h"
#include "base/cs_log.h"
#include "base/cs_math.h"
#include "mesh/cs_mesh_location.h"
#include "base/cs_parall.h"
#include "base/cs_runaway_check.h"
Include dependency graph for cs_runaway_check.cpp:

Functions

int cs_runaway_check (void)
 Check that defined field bounds are not exceeded.
void cs_runaway_check_define_field_max (int f_id, cs_real_t max_allowed)
 Define maximum value for a field, beyon which computation is aborted.
void cs_runaway_check_finalize (void)
 Check that defined field bounds are not exceeded.

Detailed Description

Runaway (diverging) computation detection.

Function Documentation

◆ cs_runaway_check()

int cs_runaway_check ( void )

Check that defined field bounds are not exceeded.

Returns
0 if no bounds are exceeded, 1 if bounds are exceeded.

◆ cs_runaway_check_define_field_max()

void cs_runaway_check_define_field_max ( int f_id,
cs_real_t max_allowed )

Define maximum value for a field, beyon which computation is aborted.

Currently, only one field is handled, so calling this multiple times replaced the previous setting. Using a negative field id removes this check.

◆ cs_runaway_check_finalize()

void cs_runaway_check_finalize ( void )

Check that defined field bounds are not exceeded.