cs_sys_coupling.h File Reference

#include "cs_base.h"
#include "cs_zone.h"

Include dependency graph for cs_sys_coupling.h:

Go to the source code of this file.

Data Structures
struct	cs_cfd2sys_intersection_t
struct	cs_cfd_sys_cplbc_t
struct	cs_sys_cpl_t

Enumerations
enum	cs_syscpl_bc_type_t {   CS_SYS_CPL_BC_INLET , CS_SYS_CPL_BC_OUTLET , CS_SYS_CPL_BC_WALL , CS_SYS_CPL_BC_VOLUME ,   CS_N_SYS_CPL_BC_TYPES , CS_SYS_CPL_BC_UKNOWN }

Functions
cs_sys_cpl_t *	cs_sys_coupling_by_id (const int cpl_id)
	Get a cfd<-->sys coupling structure by its id. More...
cs_sys_cpl_t *	cs_sys_coupling_by_name_try (const char *sys_name)
	Try getting a cfd<-->sys coupling structure by its name. More...
cs_sys_cpl_t *	cs_sys_coupling_by_name (const char *sys_name)
	Get a cfd<-->sys coupling structure by its name. More...
void	cs_sys_cplbc_add_field_to_send (cs_cfd_sys_cplbc_t *cplbc, const int field_id)
	Add a field to send during coupling to a given coupled BC. More...
void	cs_sys_cplbc_add_field_to_recv (cs_cfd_sys_cplbc_t *cplbc, const int field_id)
	Add a field to recieve during coupling to a given coupled BC. More...
void	cs_sys_cplbc_define_surf_coeff (cs_cfd_sys_cplbc_t *cplbc, const cs_real_t coeff)
	Define a surface coefficient to a given coupled BC. More...
void	cs_sys_cplbc_inverse_bnd_dir (cs_cfd_sys_cplbc_t *cplbc)
	Define a flowrate inversion between CFD and System codes if signs are inversed for a given coupled BC. More...
void	cs_sys_cplbc_add_exchanged_field (cs_cfd_sys_cplbc_t *cplbc, const int dir, const int field_id)
	Add a field to send/recv during coupling to a given coupled BC. More...
void	cs_sys_coupling_add_cplbc (cs_sys_cpl_t *sys_coupling, cs_syscpl_bc_type_t type, const cs_zone_t *z_input, const char *sel_criteria_output, const char *element_name, const int c0, const int c1, const int n_sys_elts)
	Add a coupled condition to a cfd<-->sys coupling. More...
int	cs_sys_coupling_add (const char *sys_name, const int n_cpl_phases)
	Add a cfd<->sys coupling. More...
void	cs_sys_coupling_send_data (cs_sys_cpl_t *cpl)
	send data to system code More...
void	cs_sys_coupling_recv_data (cs_sys_cpl_t *cpl)
	recieve data from system code More...
void	cs_sys_coupling_all_init (void)
	Initialize cfd<->system coupling once all couplings are defined. More...
void	cs_sys_coupling_all_finalize (void)
	Finalize all cfd<->sys couplings. More...

Enumeration Type Documentation

cs_syscpl_bc_type_t

enum cs_syscpl_bc_type_t

Enumerator
CS_SYS_CPL_BC_INLET
CS_SYS_CPL_BC_OUTLET
CS_SYS_CPL_BC_WALL
CS_SYS_CPL_BC_VOLUME
CS_N_SYS_CPL_BC_TYPES
CS_SYS_CPL_BC_UKNOWN

Function Documentation

cs_sys_coupling_add()

int cs_sys_coupling_add	(	const char *	sys_name,
		const int	n_cpl_phases
	)

Add a cfd<->sys coupling.

Parameters

[in]	sys_name	name of the new coupling
[in]	n_cpl_phases	number of phases to coupled

Returns

id of the newly created coupling

cs_sys_coupling_add_cplbc()

void cs_sys_coupling_add_cplbc	(	cs_sys_cpl_t *	sys_coupling,
		cs_syscpl_bc_type_t	type,
		const cs_zone_t *	z_input,
		const char *	sel_criteria_output,
		const char *	element_name,
		const int	c0,
		const int	c1,
		const int	n_sys_elts
	)

Add a coupled condition to a cfd<-->sys coupling.

Parameters

[in]	sys_coupling	pointer to cfd<->sys coupling
[in]	type	type of coupled condition
[in]	z_input	coupled zone (boundary or volume)
[in]	sel_criteria_output	selection criteria for cfd->sys data selection
[in]	element_name	name of coupled sys element
[in]	c0	first sys cell index
[in]	c1	second sys cell index
[in]	n_sys_elts	number of coupled cells in the system code

cs_sys_coupling_all_finalize()

void cs_sys_coupling_all_finalize

(

void

)

Finalize all cfd<->sys couplings.

cs_sys_coupling_all_init()

void cs_sys_coupling_all_init

(

void

)

Initialize cfd<->system coupling once all couplings are defined.

cs_sys_coupling_by_id()

cs_sys_cpl_t * cs_sys_coupling_by_id

(

const int

cpl_id

)

Get a cfd<-->sys coupling structure by its id.

Parameters

[in]

cpl_id

id of the requested coupling

Returns

pointer to coupling structure if found, raises an error otherwise.

cs_sys_coupling_by_name()

cs_sys_cpl_t * cs_sys_coupling_by_name

(

const char *

sys_name

)

Get a cfd<-->sys coupling structure by its name.

Parameters

[in]

sys_name

name of the requested coupling

Returns

pointer to coupling structure if found, raises and error if not found.

cs_sys_coupling_by_name_try()

cs_sys_cpl_t * cs_sys_coupling_by_name_try

(

const char *

sys_name

)

Try getting a cfd<-->sys coupling structure by its name.

Parameters

[in]

sys_name

name of the requested coupling

Returns

pointer to coupling structure if found, NULL if not found.

Parameters

[in]

sys_name

name of the requested coupling

Returns

pointer to coupling structure if found, null if not found.

cs_sys_coupling_recv_data()

void cs_sys_coupling_recv_data

(

cs_sys_cpl_t *

cpl

)

recieve data from system code

Parameters

[in]

cpl

pointer to coupling structure.

cs_sys_coupling_send_data()

void cs_sys_coupling_send_data

(

cs_sys_cpl_t *

cpl

)

send data to system code

Parameters

[in]

cpl

pointer to coupling structure.

cs_sys_cplbc_add_exchanged_field()

void cs_sys_cplbc_add_exchanged_field	(	cs_cfd_sys_cplbc_t *	cplbc,
		const int	dir,
		const int	field_id
	)

Add a field to send/recv during coupling to a given coupled BC.

Parameters

[in]	cplbc	pointer to coupled condition
[in]	dir	0 send; 1 recv
[in]	field_id	id of the field to exchange

cs_sys_cplbc_add_field_to_recv()

void cs_sys_cplbc_add_field_to_recv	(	cs_cfd_sys_cplbc_t *	cplbc,
		const int	field_id
	)

Add a field to recieve during coupling to a given coupled BC.

Parameters

[in]	cplbc	pointer to coupled condition
[in]	field_id	id of the field to recieve

cs_sys_cplbc_add_field_to_send()

void cs_sys_cplbc_add_field_to_send	(	cs_cfd_sys_cplbc_t *	cplbc,
		const int	field_id
	)

Add a field to send during coupling to a given coupled BC.

Parameters

[in]	cplbc	pointer to coupled condition
[in]	field_id	id of the field to send

cs_sys_cplbc_define_surf_coeff()

void cs_sys_cplbc_define_surf_coeff	(	cs_cfd_sys_cplbc_t *	cplbc,
		const cs_real_t	coeff
	)

Define a surface coefficient to a given coupled BC.

Parameters

[in]	cplbc	pointer to coupled condition
[in]	coeff	surface coefficient to apply

cs_sys_cplbc_inverse_bnd_dir()

void cs_sys_cplbc_inverse_bnd_dir

(

cs_cfd_sys_cplbc_t *

cplbc

)

Define a flowrate inversion between CFD and System codes if signs are inversed for a given coupled BC.

Parameters

[in]

cplbc

pointer to coupled condition