My Project
programmer's documentation
Typedefs | Functions | Variables
cs_sat_coupling.h File Reference
#include "fvm_defs.h"
#include "fvm_nodal.h"
#include "cs_base.h"
Include dependency graph for cs_sat_coupling.h:

Go to the source code of this file.

Typedefs

typedef struct _cs_sat_coupling_t cs_sat_coupling_t
 
typedef void() cs_sat_coupling_tag_t(void *context, fvm_nodal_t *mesh, cs_lnum_t n_points, cs_lnum_t point_list_base, const cs_lnum_t point_list[], int *point_tag)
 

Functions

void CS_PROCF (nbccpl, NBCCPL)(cs_int_t *nbrcpl)
 
void CS_PROCF (defloc, DEFLOC)(const cs_int_t *numcpl)
 
void CS_PROCF (nbecpl, NBECPL)(const cs_int_t *numcpl
 
void CS_PROCF (lelcpl, LELCPL)(const cs_int_t *numcpl
 
void CS_PROCF (lencpl, LENCPL)(const cs_int_t *numcpl
 
void CS_PROCF (npdcpl, NPDCPL)(const cs_int_t *numcpl
 
void CS_PROCF (coocpl, COOCPL)(const cs_int_t *numcpl
 
void CS_PROCF (pondcp, PONDCP)(const cs_int_t *numcpl
 
void CS_PROCF (varcpl, VARCPL)(const cs_int_t *numcpl
 
void CS_PROCF (tbicpl, TBICPL)(const cs_int_t *numcpl
 
void CS_PROCF (tbrcpl, TBRCPL)(const cs_int_t *numcpl
 
void CS_PROCF (mxicpl, MXICPL)(const cs_int_t *const numcpl
 
void cs_sat_coupling_define (const char *saturne_name, const char *boundary_cpl_criteria, const char *volume_cpl_criteria, const char *boundary_loc_criteria, const char *volume_loc_criteria, int verbosity)
 Define new Code_Saturne coupling. More...
 
int cs_sat_coupling_n_couplings (void)
 
cs_sat_coupling_tcs_sat_coupling_by_id (int coupling_id)
 
void cs_sat_coupling_add (const char *face_cpl_sel_c, const char *cell_cpl_sel_c, const char *face_loc_sel_c, const char *cell_loc_sel_c, const char *sat_name, int verbosity)
 
void cs_sat_coupling_add_internal (cs_sat_coupling_tag_t *tag_func, void *tag_context, const char *boundary_cpl_criteria, const char *volume_cpl_criteria, const char *boundary_loc_criteria, const char *volume_loc_criteria, float loc_tolerance, int verbosity)
 
void cs_sat_coupling_all_init (void)
 
void cs_sat_coupling_all_finalize (void)
 

Variables

void cs_int_tncesup
 
void cs_int_t cs_int_tnfbsup
 
void cs_int_t cs_int_t cs_int_tncecpl
 
void cs_int_t cs_int_t cs_int_t cs_int_tnfbcpl
 
void cs_int_t cs_int_t cs_int_t cs_int_t cs_int_tncencp
 
void cs_int_t cs_int_t cs_int_t cs_int_t cs_int_t cs_int_tnfbncp
 
void const cs_int_t const cs_int_t cs_int_tlcecpl
 
void const cs_int_t const cs_int_t cs_int_t cs_int_tlfbcpl
 
void const cs_int_t const cs_int_t cs_int_tlcencp
 
void const cs_int_t const cs_int_t cs_int_t cs_int_tlfbncp
 
void cs_int_tncedis
 
void cs_int_t cs_int_tnfbdis
 
void const cs_int_tnbrpts
 
void const cs_int_t const cs_int_titydis
 
void const cs_int_t const cs_int_t cs_int_tityloc
 
void const cs_int_t const cs_int_t cs_int_t cs_int_tlocpts
 
void const cs_int_t const cs_int_t cs_int_t cs_int_t cs_real_tcoopts
 
void const cs_int_t const cs_int_t cs_int_t cs_int_t cs_real_t cs_real_tdjppts
 
void const cs_int_t const cs_int_t cs_int_t cs_int_t cs_real_t cs_real_t cs_real_tdofpts
 
void const cs_int_t const cs_int_t cs_int_t cs_int_t cs_real_t cs_real_t cs_real_t cs_real_tpndpts
 
void const cs_int_tnbrcpl
 
void const cs_int_t cs_int_t cs_real_tpndcpl
 
void const cs_int_t cs_int_t cs_real_t cs_real_tdistof
 
void const cs_int_tnbrdis
 
void const cs_int_t const cs_int_tnbrloc
 
void const cs_int_t const cs_int_t const cs_int_tityvar
 
void const cs_int_t const cs_int_t const cs_int_t const cs_int_tstride
 
void const cs_int_t const cs_int_t const cs_int_t const cs_int_t cs_real_tvardis
 
void const cs_int_t const cs_int_t const cs_int_t const cs_int_t cs_real_t cs_real_tvarloc
 
void cs_int_t *const cs_int_t *const varmax
 

Typedef Documentation

◆ cs_sat_coupling_t

typedef struct _cs_sat_coupling_t cs_sat_coupling_t

◆ cs_sat_coupling_tag_t

typedef void() cs_sat_coupling_tag_t(void *context, fvm_nodal_t *mesh, cs_lnum_t n_points, cs_lnum_t point_list_base, const cs_lnum_t point_list[], int *point_tag)

Function Documentation

◆ CS_PROCF() [1/12]

void CS_PROCF ( coocpl  ,
COOCPL   
) const

◆ CS_PROCF() [2/12]

void CS_PROCF ( defloc  ,
DEFLOC   
) const

◆ CS_PROCF() [3/12]

void CS_PROCF ( lelcpl  ,
LELCPL   
) const

◆ CS_PROCF() [4/12]

void CS_PROCF ( lencpl  ,
LENCPL   
) const

◆ CS_PROCF() [5/12]

void CS_PROCF ( mxicpl  ,
MXICPL   
) const

◆ CS_PROCF() [6/12]

void CS_PROCF ( nbccpl  ,
NBCCPL   
)

◆ CS_PROCF() [7/12]

void CS_PROCF ( nbecpl  ,
NBECPL   
) const

◆ CS_PROCF() [8/12]

void CS_PROCF ( npdcpl  ,
NPDCPL   
) const

◆ CS_PROCF() [9/12]

void CS_PROCF ( pondcp  ,
PONDCP   
) const

◆ CS_PROCF() [10/12]

void CS_PROCF ( tbicpl  ,
TBICPL   
) const

◆ CS_PROCF() [11/12]

void CS_PROCF ( tbrcpl  ,
TBRCPL   
) const

◆ CS_PROCF() [12/12]

void CS_PROCF ( varcpl  ,
VARCPL   
) const

◆ cs_sat_coupling_add()

void cs_sat_coupling_add ( const char *  face_cpl_sel_c,
const char *  cell_cpl_sel_c,
const char *  face_loc_sel_c,
const char *  cell_loc_sel_c,
const char *  sat_name,
int  verbosity 
)

◆ cs_sat_coupling_add_internal()

void cs_sat_coupling_add_internal ( cs_sat_coupling_tag_t tag_func,
void *  tag_context,
const char *  boundary_cpl_criteria,
const char *  volume_cpl_criteria,
const char *  boundary_loc_criteria,
const char *  volume_loc_criteria,
float  loc_tolerance,
int  verbosity 
)

◆ cs_sat_coupling_all_finalize()

void cs_sat_coupling_all_finalize ( void  )

◆ cs_sat_coupling_all_init()

void cs_sat_coupling_all_init ( void  )

◆ cs_sat_coupling_by_id()

cs_sat_coupling_t* cs_sat_coupling_by_id ( int  coupling_id)

◆ cs_sat_coupling_define()

void cs_sat_coupling_define ( const char *  saturne_name,
const char *  boundary_cpl_criteria,
const char *  volume_cpl_criteria,
const char *  boundary_loc_criteria,
const char *  volume_loc_criteria,
int  verbosity 
)

Define new Code_Saturne coupling.

The arguments to cs_sat_coupling_define are:

Parameters
[in]saturne_namematching Code_Saturne application name
[in]boundary_cpl_criteriaboundary face selection criteria for coupled faces, or NULL
[in]volume_cpl_criteriacell selection criteria for coupled cells, or NULL
[in]boundary_loc_criteriaboundary face selection criteria for location (not functional)
[in]volume_loc_criteriacell selection criteria for location
[in]verbosityverbosity level

In the case of only 2 Code_Saturne instances, the 'saturne_name' argument is ignored, as there is only one matching possibility.

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

◆ cs_sat_coupling_n_couplings()

int cs_sat_coupling_n_couplings ( void  )

Variable Documentation

◆ coopts

void const cs_int_t const cs_int_t cs_int_t cs_int_t cs_real_t* coopts

◆ distof

void const cs_int_t cs_int_t cs_real_t cs_real_t* distof

◆ djppts

◆ dofpts

◆ itydis

void const cs_int_t const cs_int_t* itydis

◆ ityloc

void const cs_int_t cs_int_t * ityloc

◆ ityvar

void const cs_int_t const cs_int_t const cs_int_t* ityvar

◆ lcecpl

void const cs_int_t const cs_int_t cs_int_t* lcecpl

◆ lcencp

void const cs_int_t const cs_int_t cs_int_t* lcencp

◆ lfbcpl

void const cs_int_t const cs_int_t cs_int_t cs_int_t* lfbcpl

◆ lfbncp

void const cs_int_t const cs_int_t cs_int_t cs_int_t* lfbncp

◆ locpts

void const cs_int_t const cs_int_t cs_int_t cs_int_t* locpts

◆ nbrcpl

void const cs_int_t* nbrcpl

◆ nbrdis

void const cs_int_t * nbrdis

◆ nbrloc

void const cs_int_t const cs_int_t * nbrloc

◆ nbrpts

void const cs_int_t* nbrpts

◆ ncecpl

void const cs_int_t * ncecpl

◆ ncedis

void cs_int_t* ncedis

◆ ncencp

void const cs_int_t * ncencp

◆ ncesup

void cs_int_t* ncesup

◆ nfbcpl

void const cs_int_t const cs_int_t * nfbcpl

◆ nfbdis

void cs_int_t cs_int_t* nfbdis

◆ nfbncp

void const cs_int_t const cs_int_t * nfbncp

◆ nfbsup

void cs_int_t cs_int_t* nfbsup

◆ pndcpl

void const cs_int_t cs_int_t cs_real_t* pndcpl

◆ pndpts

◆ stride

void const cs_int_t const cs_int_t const cs_int_t const cs_int_t* stride

◆ vardis

void cs_int_t *const vardis

◆ varloc

void const cs_int_t const cs_int_t cs_real_t cs_real_t * varloc

◆ varmax

void cs_int_t* const cs_int_t* const varmax