My Project
programmer's documentation
Data Structures | Macros | Functions | Variables
cs_domain.h File Reference
#include <stdbool.h>
#include "cs_boundary.h"
#include "cs_cdo_connect.h"
#include "cs_cdo_quantities.h"
#include "cs_mesh.h"
#include "cs_mesh_quantities.h"
#include "cs_time_step.h"
#include "cs_timer.h"
#include "cs_xdef.h"
Include dependency graph for cs_domain.h:

Go to the source code of this file.

Data Structures

struct  cs_domain_cdo_context_t
 High-level metadata for handling CDO/HHO schemes. More...
 
struct  cs_domain_t
 Structure storing the main features of the computational domain and pointers to the main geometrical structures. More...
 

Macros

#define CS_DOMAIN_CDO_MODE_OFF   -1 /* CDO schemes are not used */
 
#define CS_DOMAIN_CDO_MODE_WITH_FV   1 /* CDO and legacy FV schemes are used */
 
#define CS_DOMAIN_CDO_MODE_ONLY   2 /* CDO schemes are exclusively used */
 

Functions

static void cs_domain_increment_time_step (cs_domain_t *domain)
 Update the time step after one temporal iteration. More...
 
cs_domain_tcs_domain_create (void)
 Create and initialize by default a cs_domain_t structure. More...
 
void cs_domain_free (cs_domain_t **p_domain)
 Free a cs_domain_t structure. More...
 
void cs_domain_set_cdo_mode (cs_domain_t *domain, int mode)
 Set the global variable storing the mode of activation to apply to CDO/HHO schemes. More...
 
int cs_domain_get_cdo_mode (const cs_domain_t *domain)
 Get the mode of activation for the CDO/HHO schemes. More...
 
bool cs_domain_needs_iteration (cs_domain_t *domain)
 Check if one needs to continue iterations in time. More...
 
bool cs_domain_needs_log (const cs_domain_t *domain)
 Check if an ouput is requested according to the domain setting. More...
 
void cs_domain_define_current_time_step (cs_domain_t *domain)
 Set the current time step for this new time iteration. More...
 
void cs_domain_increment_time (cs_domain_t *domain)
 Update time step after one temporal iteration. More...
 
void cs_domain_cdo_log (const cs_domain_t *domain)
 Print a welcome message indicating which mode of CDO is activated. More...
 

Variables

cs_domain_tcs_glob_domain
 

Macro Definition Documentation

◆ CS_DOMAIN_CDO_MODE_OFF

#define CS_DOMAIN_CDO_MODE_OFF   -1 /* CDO schemes are not used */

◆ CS_DOMAIN_CDO_MODE_ONLY

#define CS_DOMAIN_CDO_MODE_ONLY   2 /* CDO schemes are exclusively used */

◆ CS_DOMAIN_CDO_MODE_WITH_FV

#define CS_DOMAIN_CDO_MODE_WITH_FV   1 /* CDO and legacy FV schemes are used */

Function Documentation

◆ cs_domain_cdo_log()

void cs_domain_cdo_log ( const cs_domain_t domain)

Print a welcome message indicating which mode of CDO is activated.

Parameters
[in]domainpointer to a cs_domain_t structure

◆ cs_domain_create()

cs_domain_t* cs_domain_create ( void  )

Create and initialize by default a cs_domain_t structure.

Returns
a pointer to a cs_domain_t structure

◆ cs_domain_define_current_time_step()

void cs_domain_define_current_time_step ( cs_domain_t domain)

Set the current time step for this new time iteration.

Parameters
[in,out]domainpointer to a cs_domain_t structure

◆ cs_domain_free()

void cs_domain_free ( cs_domain_t **  p_domain)

Free a cs_domain_t structure.

Parameters
[in,out]p_domainpointer of pointer to a cs_domain_t structure

◆ cs_domain_get_cdo_mode()

int cs_domain_get_cdo_mode ( const cs_domain_t domain)

Get the mode of activation for the CDO/HHO schemes.

Parameters
[in]domainpointer to a cs_domain_t structure
Returns
the mode of activation for the CDO/HHO module

◆ cs_domain_increment_time()

void cs_domain_increment_time ( cs_domain_t domain)

Update time step after one temporal iteration.

Parameters
[in,out]domainpointer to a cs_domain_t structure

Update time step after one temporal iteration.

Parameters
[in,out]domainpointer to a cs_domain_t structure

◆ cs_domain_increment_time_step()

static void cs_domain_increment_time_step ( cs_domain_t domain)
inlinestatic

Update the time step after one temporal iteration.

Parameters
[in,out]domainpointer to a cs_domain_t structure

◆ cs_domain_needs_iteration()

bool cs_domain_needs_iteration ( cs_domain_t domain)

Check if one needs to continue iterations in time.

Parameters
[in,out]domainpointer to a cs_domain_t structure
Returns
true or false

◆ cs_domain_needs_log()

bool cs_domain_needs_log ( const cs_domain_t domain)

Check if an ouput is requested according to the domain setting.

Parameters
[in]domainpointer to a cs_domain_t structure
Returns
true or false

◆ cs_domain_set_cdo_mode()

void cs_domain_set_cdo_mode ( cs_domain_t domain,
int  mode 
)

Set the global variable storing the mode of activation to apply to CDO/HHO schemes.

Parameters
[in,out]domainpointer to a cs_domain_t structure
[in]modetype of activation for the CDO/HHO module

Variable Documentation

◆ cs_glob_domain

cs_domain_t* cs_glob_domain