cs_cdo_connect.h File Reference

#include "cs_base.h"
#include "cs_mesh.h"
#include "cs_cdo.h"
#include "cs_cdo_toolbox.h"
#include "cs_sla.h"

Include dependency graph for cs_cdo_connect.h:

Go to the source code of this file.

Data Structures
struct	cs_connect_info_t
struct	cs_cdo_connect_t

Macros
#define	CS_CDO_CONNECT_IN   (1 << 0) /* Interior entity */
#define	CS_CDO_CONNECT_BD   (1 << 1) /* Border entity */

Functions
const char *	cs_cdo_connect_flagname (short int flag)
	String related to flag in cs_connect_info_t. More...
cs_cdo_connect_t *	cs_cdo_connect_init (const cs_mesh_t *m)
	Allocate and define by default a cs_cdo_connect_t structure. More...
cs_cdo_connect_t *	cs_cdo_connect_free (cs_cdo_connect_t *connect)
	Destroy a cs_cdo_connect_t structure. More...
void	cs_cdo_connect_update (cs_cdo_connect_t *connect, cs_flag_t scheme_flag)
	Update a cs_cdo_connect_t structure with respect to the requested space scheme. More...
void	cs_cdo_connect_summary (const cs_cdo_connect_t *connect)
	Summary of connectivity information. More...
void	cs_cdo_connect_dump (const cs_cdo_connect_t *connect)
	Dump a cs_cdo_connect_t structure. More...

Macro Definition Documentation

CS_CDO_CONNECT_BD

#define CS_CDO_CONNECT_BD   (1 << 1) /* Border entity */

CS_CDO_CONNECT_IN

#define CS_CDO_CONNECT_IN   (1 << 0) /* Interior entity */

Function Documentation

cs_cdo_connect_dump()

void cs_cdo_connect_dump

(

const cs_cdo_connect_t *

connect

)

Dump a cs_cdo_connect_t structure.

Parameters

[in]

connect

pointer to cs_cdo_connect_t structure

cs_cdo_connect_flagname()

const char* cs_cdo_connect_flagname

(

short int

flag

)

String related to flag in cs_connect_info_t.

Parameters

[in]

flag

retrieve name for this flag

String related to flag in cs_connect_info_t.

Parameters

[in]

flag

retrieve name for this flag

cs_cdo_connect_free()

cs_cdo_connect_t* cs_cdo_connect_free

(

cs_cdo_connect_t *

connect

)

Destroy a cs_cdo_connect_t structure.

Parameters

[in]

connect

pointer to the cs_cdo_connect_t struct. to destroy

Returns

a NULL pointer

cs_cdo_connect_init()

cs_cdo_connect_t* cs_cdo_connect_init

(

const cs_mesh_t *

m

)

Allocate and define by default a cs_cdo_connect_t structure.

Parameters

[in]

m

pointer to a cs_mesh_t structure

Returns

a cs_cdo_connect_t structure

Parameters

[in]

m

pointer to a cs_mesh_t structure

Returns

a pointer to a cs_cdo_connect_t structure

cs_cdo_connect_summary()

void cs_cdo_connect_summary

(

const cs_cdo_connect_t *

connect

)

Summary of connectivity information.

Parameters

[in]

connect

pointer to cs_cdo_connect_t structure

cs_cdo_connect_update()

void cs_cdo_connect_update	(	cs_cdo_connect_t *	connect,
		cs_flag_t	scheme_flag
	)

Update a cs_cdo_connect_t structure with respect to the requested space scheme.

Parameters

[in,out]	connect	pointer to a cs_cdo_connect_t structure
[in]	scheme_flag	type of numerical schemes requested