programmer's documentation
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Data Structures | Enumerations | Functions | Variables
cs_domain.h File Reference
#include "cs_advection_field.h"
#include "cs_cdo_connect.h"
#include "cs_cdo_quantities.h"
#include "cs_equation.h"
#include "cs_gwf.h"
#include "cs_mesh.h"
#include "cs_mesh_quantities.h"
#include "cs_param.h"
#include "cs_property.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_boundary_t
 
struct  cs_domain_t
 

Enumerations

enum  cs_domain_key_t { CS_DOMAIN_PROFILING, CS_DOMAIN_N_KEYS }
 

Functions

cs_domain_tcs_domain_create (void)
 Create and initialize by default a cs_domain_t structure. More...
 
cs_domain_tcs_domain_free (cs_domain_t *domain)
 Free a cs_domain_t structure. More...
 
void cs_domain_set_default_boundary (cs_domain_t *domain, cs_param_boundary_type_t type)
 Set the default boundary related to this domain. More...
 
void cs_domain_add_boundary (cs_domain_t *domain, cs_param_boundary_type_t type, const char *zone_name)
 Add a boundary type defined on a mesh location. More...
 
void cs_domain_set_time_param (cs_domain_t *domain, int nt_max, double t_max)
 Set parameters for unsteady computations: the max number of time steps or the final physical time of the simulation. More...
 
void cs_domain_set_output_param (cs_domain_t *domain, int nt_list, int verbosity)
 Set auxiliary parameters related to the way output is done. More...
 
void cs_domain_update_advfield (cs_domain_t *domain)
 Set to true the automatic update of all advection fields. More...
 
void cs_domain_set_advanced_param (cs_domain_t *domain, cs_domain_key_t key, const char *keyval)
 Set auxiliary parameters related to a cs_domain_t structure. More...
 
void cs_domain_def_time_step_by_function (cs_domain_t *domain, cs_timestep_func_t *func, void *func_input)
 Define the value of the time step thanks to a predefined function. More...
 
void cs_domain_def_time_step_by_value (cs_domain_t *domain, double dt)
 Define the value of the time step. More...
 
void cs_domain_update_mesh_locations (cs_domain_t *domain)
 Add new mesh locations related to domain boundaries from existing mesh locations. More...
 
void cs_domain_setup_predefined_equations (cs_domain_t *domain)
 Setup predefined equations which are activated. More...
 
void cs_domain_set_scheme_flag (cs_domain_t *domain)
 Define the scheme flag for the current computational domain. More...
 
void cs_domain_finalize_setup (cs_domain_t *domain, cs_mesh_t *mesh, const cs_mesh_quantities_t *mesh_quantities)
 Build a cs_domain_t structure. More...
 
void cs_domain_initialize_systems (cs_domain_t *domain)
 Initialize systems of equations and their related field values according to the user settings. 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_solve (cs_domain_t *domain)
 Solve all the equations of a computational domain for one time step. More...
 
void cs_domain_process_after_solve (cs_domain_t *domain)
 Process the computational domain after the resolution. More...
 
void cs_domain_read_restart (const cs_domain_t *domain)
 Read a restart file for the CDO module. More...
 
void cs_domain_write_restart (const cs_domain_t *domain)
 Write a restart file for the CDO module. More...
 
void cs_domain_summary (const cs_domain_t *domain)
 Summary of a cs_domain_t structure. More...
 

Variables

cs_domain_tcs_glob_domain
 

Enumeration Type Documentation

Enumerator
CS_DOMAIN_PROFILING 
CS_DOMAIN_N_KEYS 

Function Documentation

void cs_domain_add_boundary ( cs_domain_t domain,
cs_param_boundary_type_t  type,
const char *  zone_name 
)

Add a boundary type defined on a mesh location.

Parameters
[in,out]domainpointer to a cs_domain_t structure
[in]typetype of boundary to set
[in]zone_namename of the zone related to this boundary
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
void cs_domain_def_time_step_by_function ( cs_domain_t domain,
cs_timestep_func_t func,
void *  func_input 
)

Define the value of the time step thanks to a predefined function.

Parameters
[in,out]domainpointer to a cs_domain_t structure
[in]funcpointer to a cs_timestep_func_t function
[in]func_inputpointer to a structure cast on-the-fly
void cs_domain_def_time_step_by_value ( cs_domain_t domain,
double  dt 
)

Define the value of the time step.

Parameters
[in,out]domainpointer to a cs_domain_t structure
[in]dtvalue of the constant 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
void cs_domain_finalize_setup ( cs_domain_t domain,
cs_mesh_t mesh,
const cs_mesh_quantities_t mesh_quantities 
)

Build a cs_domain_t structure.

Parameters
[in,out]domainpointer to a cs_domain_t struct.
[in,out]meshpointer to a cs_mesh_t struct.
[in]mesh_quantitiespointer to a cs_mesh_quantities_t struct.
cs_domain_t* cs_domain_free ( cs_domain_t domain)

Free a cs_domain_t structure.

Parameters
[in,out]domainpointer to the cs_domain_t structure to free
Returns
a NULL pointer
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
void cs_domain_initialize_systems ( cs_domain_t domain)

Initialize systems of equations and their related field values according to the user settings.

Parameters
[in,out]domainpointer to a cs_domain_t structure
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
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
void cs_domain_process_after_solve ( cs_domain_t domain)

Process the computational domain after the resolution.

Parameters
[in]domainpointer to a cs_domain_t structure
void cs_domain_read_restart ( const cs_domain_t domain)

Read a restart file for the CDO module.

Parameters
[in]domainpointer to a cs_domain_t structure
void cs_domain_set_advanced_param ( cs_domain_t domain,
cs_domain_key_t  key,
const char *  keyval 
)

Set auxiliary parameters related to a cs_domain_t structure.

Parameters
[in,out]domainpointer to a cs_domain_t structure
[in]keykey related to the parameter to set
[in]keyvalvalue related to the parameter to set
void cs_domain_set_default_boundary ( cs_domain_t domain,
cs_param_boundary_type_t  type 
)

Set the default boundary related to this domain.

Parameters
[in,out]domainpointer to a cs_domain_t structure
[in]typetype of boundary to set
void cs_domain_set_output_param ( cs_domain_t domain,
int  nt_list,
int  verbosity 
)

Set auxiliary parameters related to the way output is done.

Parameters
[in,out]domainpointer to a cs_domain_t structure
[in]nt_listoutput frequency into the listing
[in]verbositylevel of information displayed
void cs_domain_set_scheme_flag ( cs_domain_t domain)

Define the scheme flag for the current computational domain.

Parameters
[in,out]domainpointer to a cs_domain_t struct.
void cs_domain_set_time_param ( cs_domain_t domain,
int  nt_max,
double  t_max 
)

Set parameters for unsteady computations: the max number of time steps or the final physical time of the simulation.

Parameters
[in,out]domainpointer to a cs_domain_t structure
[in]nt_maxmax. number of time step iterations
[in]t_maxfinal physical time of the simulation
void cs_domain_setup_predefined_equations ( cs_domain_t domain)

Setup predefined equations which are activated.

Parameters
[in,out]domainpointer to a cs_domain_t structure
void cs_domain_solve ( cs_domain_t domain)

Solve all the equations of a computational domain for one time step.

Parameters
[in,out]domainpointer to a cs_domain_t structure
void cs_domain_summary ( const cs_domain_t domain)

Summary of a cs_domain_t structure.

Parameters
[in]domainpointer to the cs_domain_t structure to summarize
void cs_domain_update_advfield ( cs_domain_t domain)

Set to true the automatic update of all advection fields.

Parameters
[in,out]domainpointer to a cs_domain_t structure
void cs_domain_update_mesh_locations ( cs_domain_t domain)

Add new mesh locations related to domain boundaries from existing mesh locations.

Parameters
[in]domainpointer to a cs_domain_t structure
void cs_domain_write_restart ( const cs_domain_t domain)

Write a restart file for the CDO module.

Parameters
[in]domainpointer to a cs_domain_t structure

Variable Documentation

cs_domain_t* cs_glob_domain