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_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 reverse, int verbosity)
	Define new code_saturne coupling. More...
int	cs_sat_coupling_n_couplings (void)
cs_sat_coupling_t *	cs_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 reverse, 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 reverse, int verbosity)
void	cs_sat_coupling_all_init (void)
void	cs_sat_coupling_array_exchange (int cpl_id, cs_lnum_t nbrdis, cs_lnum_t nbrloc, cs_real_t *vardis, cs_real_t *varloc)
void	cs_sat_coupling_exchange_at_cells (cs_field_t *f, cs_real_t *rhs, cs_real_t *fimp)
	code_saturne/code_saturne coupling using volumic source terms. More...
void	cs_sat_coupling_bnd_initialize (int *bc_type)
	code_saturne/code_saturne boundary coupling initialization call More...
void	cs_sat_coupling_initialize (void)
	Initialization of main variables for code_saturne/code_saturne coupling. More...
void	cs_sat_coupling_locate_all (void)
	Set the list of cells and boundary faces associated to a coupling and a cloud of point. More...
void	cs_sat_coupling_exchange_at_bnd_faces (int *bc_type, cs_real_t *dt)
	code_saturne/code_saturne coupling using boundary conditions More...
void	cs_sat_coupling_all_finalize (void)

Variables
int	cs_glob_sat_coupling_face_interpolation_type

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_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	reverse,
		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	reverse,
		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_array_exchange()

void cs_sat_coupling_array_exchange	(	int	cpl_id,
		cs_lnum_t	nbrdis,
		cs_lnum_t	nbrloc,
		cs_real_t *	vardis,
		cs_real_t *	varloc
	)

cs_sat_coupling_bnd_initialize()

void cs_sat_coupling_bnd_initialize

(

int *

bc_type

)

code_saturne/code_saturne boundary coupling initialization call

Parameters

[in]

bc_type

boundary face types

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	reverse,
		int	verbosity
	)

Define new code_saturne coupling.

The arguments to cs_sat_coupling_define are:

Parameters

[in]	saturne_name	matching code_saturne application name
[in]	boundary_cpl_criteria	boundary face selection criteria for coupled faces, or NULL
[in]	volume_cpl_criteria	cell selection criteria for coupled cells, or NULL
[in]	boundary_loc_criteria	boundary face selection criteria for location (not functional)
[in]	volume_loc_criteria	cell selection criteria for location
[in]	reverse	reverse mode if 1
[in]	verbosity	verbosity 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.

The arguments to cs_sat_coupling_define are:

Parameters

[in]	saturne_name	matching code_saturne application name
[in]	boundary_cpl_criteria	boundary face selection criteria for coupled faces, or nullptr
[in]	volume_cpl_criteria	cell selection criteria for coupled cells, or nullptr
[in]	boundary_loc_criteria	boundary face selection criteria for location (not functional)
[in]	volume_loc_criteria	cell selection criteria for location
[in]	reverse	reverse mode if 1
[in]	verbosity	verbosity 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_exchange_at_bnd_faces()

void cs_sat_coupling_exchange_at_bnd_faces	(	int *	bc_type,
		cs_real_t *	dt
	)

code_saturne/code_saturne coupling using boundary conditions

Parameters

[in]	bc_type	boundary face types
[in]	dt	time step (per cell)

cs_sat_coupling_exchange_at_cells()

void cs_sat_coupling_exchange_at_cells	(	cs_field_t *	f,
		cs_real_t *	rhs,
		cs_real_t *	fimp
	)

code_saturne/code_saturne coupling using volumic source terms.

Parameters

[in]	f	pointer to cs_field_t
[out]	rhs	Explicit terms (RHS)
[out]	fimp	Implicit source terms

cs_sat_coupling_initialize()

void cs_sat_coupling_initialize

(

void

)

Initialization of main variables for code_saturne/code_saturne coupling.

cs_sat_coupling_locate_all()

void cs_sat_coupling_locate_all

(

void

)

Set the list of cells and boundary faces associated to a coupling and a cloud of point.

The local "support" cells and boundary faces are used to locate the values in the distant "coupled" cells and faces. Depending on the role of sender and/or receiver of the current process in the coupling, some of these sets can be empty or not.

The cell values are always located and interpolated on the distant "cells" support. The face values are located and interpolated on the distant "face" support if present, or on the distant "cell" support if not.

If the input arrays LCESUP and LFBSUP are not ordered, they will be orderd in output.

cs_sat_coupling_n_couplings()

int cs_sat_coupling_n_couplings

(

void

)

Variable Documentation

cs_glob_sat_coupling_face_interpolation_type

int cs_glob_sat_coupling_face_interpolation_type

extern