cs_user_extra_operations.cpp File Reference

The cs_user_extra_operations series of function have a very broad purpose (i.e. handing anything that does not have another dedicated user function). More...

#include "cs_headers.h"
#include <assert.h>
#include <math.h>

Include dependency graph for cs_user_extra_operations.cpp:

Functions
void	cs_user_extra_operations_initialize (cs_domain_t *domain)
	Initialize variables or setup extra operations. More...
void	cs_user_extra_operations (cs_domain_t *domain)
	User operations called at the end of each time step. More...
void	cs_user_extra_operations_finalize (cs_domain_t *domain)
	User operations called at the end of the calculation. More...

Detailed Description

The cs_user_extra_operations series of function have a very broad purpose (i.e. handing anything that does not have another dedicated user function).

In most cases, cs_user_extra_operations is used for data extraction and postprocessing, but may also be used to steer a computation, for example.

Function Documentation

cs_user_extra_operations()

void cs_user_extra_operations

(

cs_domain_t *

domain

)

User operations called at the end of each time step.

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

Parameters

[in,out]

domain

pointer to a cs_domain_t structure

cs_user_extra_operations_finalize()

void cs_user_extra_operations_finalize

(

cs_domain_t *

domain

)

User operations called at the end of the calculation.

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

Parameters

[in,out]

domain

pointer to a cs_domain_t structure

cs_user_extra_operations_initialize()

void cs_user_extra_operations_initialize

(

cs_domain_t *

domain

)

Initialize variables or setup extra operations.

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]

domain

pointer to a cs_domain_t structure