programmer's documentation
Functions
cs_syr_coupling.h File Reference
#include "fvm_defs.h"
#include "cs_base.h"
Include dependency graph for cs_syr_coupling.h:

Go to the source code of this file.

Functions

void nbcsyr (cs_int_t *const n_couplings)
 
void tsursy (cs_int_t *const cplnum, cs_int_t *issurf)
 
void tvolsy (cs_int_t *const cplnum, cs_int_t *isvol)
 
void nbesyr (const cs_int_t *coupl_num, const cs_int_t *mode, cs_int_t *n_coupl_elts)
 
void leltsy (const cs_int_t *coupl_num, const cs_int_t *mode, cs_lnum_t *coupl_elt_list)
 
void varsyi (cs_int_t *numsyr, cs_int_t *mode, cs_real_t *tsolid)
 
void varsyo (cs_int_t *numsyr, cs_int_t *mode, cs_int_t *lstelt, cs_real_t *tfluid, cs_real_t *hfluid)
 
void ctbvsy (cs_int_t *numsyr, cs_real_t *tfluid, cs_real_t *ctbimp, cs_real_t *ctbexp)
 
void cs_syr_coupling_define (const char *syrthes_name, const char *boundary_criteria, const char *volume_criteria, char projection_axis, bool allow_nonmatching, float tolerance, int verbosity, int visualization)
 Define new SYRTHES coupling. More...
 
void cs_syr_coupling_all_init (void)
 
void cs_syr_coupling_all_finalize (void)
 
int cs_syr_coupling_n_couplings (void)
 
void cs_syr_coupling_set_conservativity (int flag)
 
void cs_syr_coupling_set_explicit_treatment (void)
 
void cs_syr_coupling_log_setup (void)
 Log SYRTHES coupling setup information. More...
 
void cs_syr_coupling_init_meshes (void)
 Create coupled meshes and setup PLE locator for Syrthes couplings. More...
 

Function Documentation

◆ cs_syr_coupling_all_finalize()

void cs_syr_coupling_all_finalize ( void  )

◆ cs_syr_coupling_all_init()

void cs_syr_coupling_all_init ( void  )

◆ cs_syr_coupling_define()

void cs_syr_coupling_define ( const char *  syrthes_name,
const char *  boundary_criteria,
const char *  volume_criteria,
char  projection_axis,
bool  allow_nonmatching,
float  tolerance,
int  verbosity,
int  visualization 
)

Define new SYRTHES coupling.

The arguments to cs_syr_coupling_define are:

Parameters
[in]syrthes_namematching SYRTHES application name
[in]boundary_criteriasurface selection criteria, or NULL
[in]volume_criteriavolume selection criteria, or NULL
[in]projection_axisx', 'y', or 'y' for 2D projection axis (case independent), or ' ' for standard 3D coupling
[in]allow_nonmatchingallow nearest-neighbor mapping where matching within tolerance is not available (useful when meshes have a different level of detail)
[in]toleranceaddition to local extents of each element extent = base_extent * (1 + tolerance)
[in]verbosityverbosity level
[in]visualizationvisualization output level (0 or 1)

In the case of a single Code_Saturne and single SYRTHES instance, the 'syrthes_name' argument is ignored, as there is only one matching possibility.

In case of multiple couplings, a coupling will be matched with available SYRTHES instances based on the 'syrthes_name' argument.

◆ cs_syr_coupling_init_meshes()

void cs_syr_coupling_init_meshes ( void  )

Create coupled meshes and setup PLE locator for Syrthes couplings.

◆ cs_syr_coupling_log_setup()

void cs_syr_coupling_log_setup ( void  )

Log SYRTHES coupling setup information.

◆ cs_syr_coupling_n_couplings()

int cs_syr_coupling_n_couplings ( void  )

◆ cs_syr_coupling_set_conservativity()

void cs_syr_coupling_set_conservativity ( int  flag)

◆ cs_syr_coupling_set_explicit_treatment()

void cs_syr_coupling_set_explicit_treatment ( void  )

◆ ctbvsy()

void ctbvsy ( cs_int_t numsyr,
cs_real_t tfluid,
cs_real_t ctbimp,
cs_real_t ctbexp 
)

◆ leltsy()

void leltsy ( const cs_int_t coupl_num,
const cs_int_t mode,
cs_lnum_t coupl_elt_list 
)

◆ nbcsyr()

void nbcsyr ( cs_int_t *const  n_couplings)

◆ nbesyr()

void nbesyr ( const cs_int_t coupl_num,
const cs_int_t mode,
cs_int_t n_coupl_elts 
)

◆ tsursy()

void tsursy ( cs_int_t *const  cplnum,
cs_int_t issurf 
)

◆ tvolsy()

void tvolsy ( cs_int_t *const  cplnum,
cs_int_t isvol 
)

◆ varsyi()

void varsyi ( cs_int_t numsyr,
cs_int_t mode,
cs_real_t tsolid 
)

◆ varsyo()

void varsyo ( cs_int_t numsyr,
cs_int_t mode,
cs_int_t lstelt,
cs_real_t tfluid,
cs_real_t hfluid 
)