My Project
programmer's documentation
Functions
cs_user_extra_operations.c File Reference

This function is called at the end of each time step, and has a very general purpose (i.e. anything that does not have another dedicated user function) More...

#include "cs_defs.h"
#include "cs_math.h"
#include <assert.h>
#include <math.h>
#include <ple_coupling.h>
#include "cs_headers.h"
#include "cs_prototypes.h"
Include dependency graph for cs_user_extra_operations.c:

Functions

void cs_user_extra_operations_initialize (cs_domain_t *domain)
 Initialize variables. More...
 
void cs_user_extra_operations (cs_domain_t *domain)
 This function is called at the end of each time step. More...
 
void cs_user_extra_operations_finalize (cs_domain_t *domain)
 This function is called at the end of the calculation. More...
 

Detailed Description

This function is called at the end of each time step, and has a very general purpose (i.e. anything that does not have another dedicated user function)

Function Documentation

◆ cs_user_extra_operations()

void cs_user_extra_operations ( cs_domain_t domain)

This function is called at the end of each time step.

It has a very general purpose, although it is recommended to handle mainly postprocessing or data-extraction type operations.

Parameters
[in,out]domainpointer to a cs_domain_t structure

◆ cs_user_extra_operations_finalize()

void cs_user_extra_operations_finalize ( cs_domain_t domain)

This function is called at the end of the calculation.

It has a very general purpose, although it is recommended to handle mainly postprocessing or data-extraction type operations.

Parameters
[in,out]domainpointer to a cs_domain_t structure

◆ cs_user_extra_operations_initialize()

void cs_user_extra_operations_initialize ( cs_domain_t domain)

Initialize variables.

This function is called at beginning of the computation (restart or not) before the time step loop.

This is intended to initialize or modify (when restarted) variable and time step values.

Parameters
[in,out]domainpointer to a cs_domain_t structure