My Project
programmer's documentation
Functions | Variables
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 CS_PROCF (nbcsyr, NBCSYR)(cs_int_t *const n_couplings)
 
void CS_PROCF (tsursy, TSURSY)(cs_int_t *const cplnum
 
void CS_PROCF (tvolsy, TVOLSY)(cs_int_t *const cplnum
 
void CS_PROCF (nbesyr, NBESYR)(const cs_int_t *coupl_num
 
void CS_PROCF (leltsy, LELTSY)(const cs_int_t *coupl_num
 
void CS_PROCF (varsyi, VARSYI)(cs_int_t *numsyr
 
void CS_PROCF (varsyo, VARSYO)(cs_int_t *numsyr
 
void CS_PROCF (ctbvsy, CTBVSY)(cs_int_t *numsyr
 
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...
 

Variables

void cs_int_tissurf
 
void cs_int_tisvol
 
void const cs_int_tmode
 
void const cs_int_t cs_int_tn_coupl_elts
 
void const cs_int_t cs_lnum_tcoupl_elt_list
 
void cs_int_t cs_real_ttsolid
 
void cs_int_t cs_int_tlstelt
 
void cs_int_t cs_int_t cs_real_ttfluid
 
void cs_int_t cs_int_t cs_real_t cs_real_thfluid
 
void cs_real_t cs_real_tctbimp
 
void cs_real_t cs_real_t cs_real_tctbexp
 

Function Documentation

◆ CS_PROCF() [1/8]

void CS_PROCF ( ctbvsy  ,
CTBVSY   
)

◆ CS_PROCF() [2/8]

void CS_PROCF ( leltsy  ,
LELTSY   
) const

◆ CS_PROCF() [3/8]

void CS_PROCF ( nbcsyr  ,
NBCSYR   
) const

◆ CS_PROCF() [4/8]

void CS_PROCF ( nbesyr  ,
NBESYR   
) const

◆ CS_PROCF() [5/8]

void CS_PROCF ( tsursy  ,
TSURSY   
) const

◆ CS_PROCF() [6/8]

void CS_PROCF ( tvolsy  ,
TVOLSY   
) const

◆ CS_PROCF() [7/8]

void CS_PROCF ( varsyi  ,
VARSYI   
)

◆ CS_PROCF() [8/8]

void CS_PROCF ( varsyo  ,
VARSYO   
)

◆ 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  )

Variable Documentation

◆ coupl_elt_list

void const cs_int_t cs_lnum_t* coupl_elt_list

◆ ctbexp

◆ ctbimp

void cs_real_t cs_real_t* ctbimp

◆ hfluid

◆ issurf

void cs_int_t* issurf

◆ isvol

void cs_int_t* isvol

◆ lstelt

void cs_int_t cs_int_t* lstelt

◆ mode

void cs_int_t * mode

◆ n_coupl_elts

void const cs_int_t cs_int_t* n_coupl_elts

◆ tfluid

void cs_real_t* tfluid

◆ tsolid

void cs_int_t cs_real_t* tsolid