cs_paramedmem_coupling.h File Reference

#include "base/cs_defs.h"
#include "base/cs_field.h"
#include "base/cs_zone.h"

Include dependency graph for cs_paramedmem_coupling.h:

Go to the source code of this file.

Namespaces
namespace	cs

Typedefs
using	paramedmem_coupling_t = cs_paramedmem_coupling_t

Enumerations
enum	cs_medcpl_space_discr_t { CS_MEDCPL_ON_CELLS , CS_MEDCPL_ON_NODES , CS_MEDCPL_ON_NODES_FE }
enum	cs_medcpl_time_discr_t { CS_MEDCPL_NO_TIME , CS_MEDCPL_ONE_TIME , CS_MEDCPL_LINEAR_TIME }
enum	cs_medcpl_field_nature_t {   CS_MEDCPL_FIELD_INT_CONSERVATION , CS_MEDCPL_FIELD_INT_MAXIMUM , CS_MEDCPL_FIELD_EXT_CONSERVATION , CS_MEDCPL_FIELD_EXT_MAXIMUM ,   CS_MEDCPL_FIELD_N_NATURE }
enum	cs_medcpl_dec_t { CS_MEDCPL_INTERPKERNELDEC , CS_MEDCPL_CFEMDEC }

Functions
cs_paramedmem_coupling_t *	cs_paramedmem_coupling_by_id (int cpl_id)
	Retrieve coupling struct pointer by id. More...
cs_paramedmem_coupling_t *	cs_paramedmem_coupling_by_name (const char *name)
	Retrieve coupling struct pointer by name. More...
cs_paramedmem_coupling_t *	cs_paramedmem_coupling_create (const char *app1_name, const char *app2_name, const char *cpl_name, cs_medcpl_dec_t type_dec)
	Create a new ParaMEDMEM coupling. More...
cs_paramedmem_coupling_t *	cs_paramedmem_coupling_create_uncoupled (const char *cpl_name)
	Create a new ParaMEDMEM handler structure with no actual coupling. More...
void	cs_paramedmem_coupling_destroy (cs_paramedmem_coupling_t *c)
	Destroy a given ParaMEDMEM coupling structure. More...
void	cs_paramedmem_coupling_all_finalize (void)
	Destroy all coupling structures. More...
int	cs_paramedmem_get_number_of_couplings (void)
	Get number of defined couplings. More...
void	cs_paramedmem_coupling_all_init (void)
	initialize couplings based on user functions. More...
void	cs_paramedmem_coupling_define_mesh_fields (void)
	initialize coupled mesh and fields based on user functions. More...
void	cs_paramedmem_coupling_log_setup (void)
	Log ParaMEDMEM coupling setup information. More...

Enumeration Type Documentation

cs_medcpl_dec_t

enum cs_medcpl_dec_t

Enumerator
CS_MEDCPL_INTERPKERNELDEC
CS_MEDCPL_CFEMDEC

cs_medcpl_field_nature_t

enum cs_medcpl_field_nature_t

Enumerator
CS_MEDCPL_FIELD_INT_CONSERVATION
CS_MEDCPL_FIELD_INT_MAXIMUM
CS_MEDCPL_FIELD_EXT_CONSERVATION
CS_MEDCPL_FIELD_EXT_MAXIMUM
CS_MEDCPL_FIELD_N_NATURE

cs_medcpl_space_discr_t

enum cs_medcpl_space_discr_t

Enumerator
CS_MEDCPL_ON_CELLS
CS_MEDCPL_ON_NODES
CS_MEDCPL_ON_NODES_FE

cs_medcpl_time_discr_t

enum cs_medcpl_time_discr_t

Enumerator
CS_MEDCPL_NO_TIME
CS_MEDCPL_ONE_TIME
CS_MEDCPL_LINEAR_TIME

Function Documentation

cs_paramedmem_coupling_all_finalize()

void cs_paramedmem_coupling_all_finalize

(

void

)

Destroy all coupling structures.

cs_paramedmem_coupling_all_init()

void cs_paramedmem_coupling_all_init

(

void

)

initialize couplings based on user functions.

cs_paramedmem_coupling_by_id()

cs_paramedmem_coupling_t * cs_paramedmem_coupling_by_id

(

int

cpl_id

)

Retrieve coupling struct pointer by id.

Parameters

[in]

cpl_id

index of the sought coupling

Returns

pointer to cs_paramedmem_coupling_t struct. Raise an error if the coupling does not exist.

cs_paramedmem_coupling_by_name()

cs_paramedmem_coupling_t * cs_paramedmem_coupling_by_name

(

const char *

name

)

Retrieve coupling struct pointer by name.

Parameters

[in]

name

name of the coupling

Returns

pointer to cs_paramedmem_coupling_t struct or null if not found.

cs_paramedmem_coupling_create()

cs_paramedmem_coupling_t * cs_paramedmem_coupling_create	(	const char *	app1_name,
		const char *	app2_name,
		const char *	cpl_name,
		cs_medcpl_dec_t	type_dec
	)

Create a new ParaMEDMEM coupling.

Parameters

[in]	app1_name	Name of app n°1 or null if calling app is app1
[in]	app2_name	Name of app n°2 or null if calling app is app2
[in]	cpl_name	Name of the coupling. If null an automatic name is generated.
[in]	type_dec	Type of DEC used for Data exchange

Returns

pointer to newly created cs_paramedmem_coupling_t structure.

cs_paramedmem_coupling_create_uncoupled()

cs_paramedmem_coupling_t * cs_paramedmem_coupling_create_uncoupled

(

const char *

cpl_name

)

Create a new ParaMEDMEM handler structure with no actual coupling.

This can be useful for a "dry run" when setting up a coupling, so as to first debug local commands before actually running in coupled mode.

In this case, data "received" matches the initialized values.

Parameters

[in]

cpl_name

Name of the coupling. If null an automatic name is generated.

Returns

pointer to newly created cs_paramedmem_coupling_t structure.

cs_paramedmem_coupling_define_mesh_fields()

void cs_paramedmem_coupling_define_mesh_fields

(

void

)

initialize coupled mesh and fields based on user functions.

cs_paramedmem_coupling_destroy()

void cs_paramedmem_coupling_destroy

(

cs_paramedmem_coupling_t *

c

)

Destroy a given ParaMEDMEM coupling structure.

Parameters

[in]

c

pointer to cs_paramedmem_coupling_t structure

cs_paramedmem_coupling_log_setup()

void cs_paramedmem_coupling_log_setup

(

void

)

Log ParaMEDMEM coupling setup information.

cs_paramedmem_get_number_of_couplings()

int cs_paramedmem_get_number_of_couplings

(

void

)

Get number of defined couplings.

Returns

number of defined couplings (int)