cs_runaway_check.h File Reference

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

Include dependency graph for cs_runaway_check.h:

Go to the source code of this file.

Functions
int	cs_runaway_check (void)
	Check that defined field bounds are not exceeded. More...
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. More...
void	cs_runaway_check_finalize (void)
	Check that defined field bounds are not exceeded. More...

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.