cs_defs.h File Reference

#include "base/cs_config.h"
#include <stdlib.h>

Include dependency graph for cs_defs.h:

Go to the source code of this file.

Data Structures
struct	cs_double_int_t
struct	cs_nvec3_t

Macros
#define	_LIBINTL_H
#define	_(String)
#define	N_(String)
#define	textdomain(String)
#define	gettext(String)
#define	dgettext(Domain, String)
#define	dcgettext(Domain, String, Type)
#define	bindtextdomain(Domain, Directory)
#define	__STDC_VERSION__   1989
#define	inline
#define	restrict
#define	DEPRECATED
#define	_Bool   signed char;
#define	bool   _Bool
#define	false   0
#define	true   1
#define	__bool_true_false_are_defined   1
#define	CS_GNUM_TYPE   CS_UINT32
#define	CS_LNUM_TYPE   CS_INT32
#define	CS_INT_TYPE   CS_INT32
#define	CS_UINT_TYPE   CS_UINT32
#define	CS_FLAG_TYPE   CS_UINT16
#define	CS_EFLAG_TYPE   CS_UINT_TYPE
#define	CS_REAL_TYPE   CS_DOUBLE
#define	CS_COORD_TYPE   CS_DOUBLE
#define	CS_THR_MIN   128
#define	CS_CL_SIZE   64
#define	CS_ABS(a)
#define	CS_MIN(a, b)
#define	CS_MAX(a, b)
#define	CS_UNUSED(x)
#define	CS_NO_WARN_IF_UNUSED(x)
#define	BEGIN_C_DECLS
#define	END_C_DECLS
#define	CS_F_HOST
#define	CS_F_DEVICE
#define	CS_F_HOST_DEVICE
#define	CS_V_CONSTANT   static const
#define	CS_PROCF(x, y)

Typedefs
typedef unsigned	cs_gnum_t
	global mesh entity number
typedef int	cs_lnum_t
	local mesh entity id
typedef double	cs_coord_t
typedef double	cs_real_t
	Floating-point value.
typedef char	cs_byte_t
typedef unsigned short int	cs_flag_t
typedef double	cs_nreal_t
typedef double	cs_dreal_t
typedef double	cs_rreal_t
typedef cs_lnum_t	cs_lnum_2_t[2]
	vector of 2 local mesh-entity ids
typedef cs_lnum_t	cs_lnum_3_t[3]
typedef cs_coord_t	cs_coord_3_t[3]
typedef cs_real_t	cs_real_2_t[2]
	vector of 2 floating-point values
typedef cs_real_t	cs_real_3_t[3]
	vector of 3 floating-point values
typedef cs_real_t	cs_real_4_t[4]
	vector of 4 floating-point values
typedef cs_real_t	cs_real_6_t[6]
	vector of 6 floating-point values
typedef cs_real_t	cs_real_9_t[9]
typedef cs_real_t	cs_real_10_t[10]
typedef cs_real_t	cs_real_23_t[2][3]
typedef cs_real_t	cs_real_33_t[3][3]
	3x3 matrix of floating-point values
typedef cs_real_t	cs_real_66_t[6][6]
	6x6 matrix of floating-point values
typedef cs_real_t	cs_real_99_t[9][9]
typedef cs_real_t	cs_real_333_t[3][3][3]
typedef cs_real_t	cs_real_34_t[3][4]
typedef cs_real_t	cs_real_63_t[6][3]
typedef cs_real_t	cs_real_69_t[6][9]
typedef cs_real_33_t	cs_real_332_t[2]
	vector of 2 3x3 matrices of floating-point values
typedef cs_real_66_t	cs_real_662_t[2]
typedef cs_nreal_t	cs_nreal_3_t[3]
typedef cs_dreal_t	cs_dreal_3_t[3]
typedef cs_rreal_t	cs_rreal_3_t[3]
typedef void *	cs_destructor_t(void *s)
	Destroy a given structure.

Enumerations
enum	cs_datatype_t {   CS_DATATYPE_NULL , CS_CHAR , CS_FLOAT , CS_DOUBLE ,   CS_UINT16 , CS_INT32 , CS_INT64 , CS_UINT32 ,   CS_UINT64 }
enum	cs_interlace_t { CS_INTERLACE , CS_NO_INTERLACE }

Functions
static cs_lnum_t	cs_align (cs_lnum_t i, cs_lnum_t m)
	Given a base index i, return the next index aligned with a size m.
static int	cs_get_thread_id (void)
	Retrieve the associated thread id (0 if no OpenMP or if outside an OpenMP region)

Variables
const char	cs_empty_string []
const size_t	cs_datatype_size []
const char *	cs_datatype_name []
int	cs_glob_n_threads
int	cs_glob_rank_id
int	cs_glob_n_ranks
int	cs_glob_node_rank_id
int	cs_glob_node_n_ranks

Detailed Description

Base macro and typedef definitions for system portability.

Macro Definition Documentation

_

#define _

(

String

)

Value:

(String)

__bool_true_false_are_defined

#define __bool_true_false_are_defined   1

__STDC_VERSION__

#define __STDC_VERSION__   1989

_Bool

#define _Bool   signed char;

_LIBINTL_H

#define _LIBINTL_H

Value:

                        /* Prevent inclusion of <libintl.h> by other files
                        with incorrect or missing checks;
                        TODO locate files causing issues to avoid
                        requiring this workaround */

BEGIN_C_DECLS

#define BEGIN_C_DECLS

bindtextdomain

#define bindtextdomain	(		Domain,
			Directory )

Value:

(Domain)

bool

#define bool   _Bool

CS_ABS

#define CS_ABS

(

a

)

Value:

((a) <  0  ? -(a) : (a))

Absolute value of a

CS_CL_SIZE

#define CS_CL_SIZE   64

CS_COORD_TYPE

#define CS_COORD_TYPE   CS_DOUBLE

CS_EFLAG_TYPE

#define CS_EFLAG_TYPE   CS_UINT_TYPE

CS_F_DEVICE

#define CS_F_DEVICE

CS_F_HOST

#define CS_F_HOST

CS_F_HOST_DEVICE

#define CS_F_HOST_DEVICE

CS_FLAG_TYPE

#define CS_FLAG_TYPE   CS_UINT16

CS_GNUM_TYPE

#define CS_GNUM_TYPE   CS_UINT32

CS_INT_TYPE

#define CS_INT_TYPE   CS_INT32

CS_LNUM_TYPE

#define CS_LNUM_TYPE   CS_INT32

CS_MAX

#define CS_MAX	(		a,
			b )

Value:

((a) > (b) ?  (a) : (b))

Maximum of a et b

CS_MIN

#define CS_MIN	(		a,
			b )

Value:

((a) < (b) ?  (a) : (b))

Minimum of a et b

CS_NO_WARN_IF_UNUSED

#define CS_NO_WARN_IF_UNUSED

(

x

)

Value:

(void)(x)

CS_PROCF

#define CS_PROCF	(		x,
			y )

Value:

x##_

CS_REAL_TYPE

#define CS_REAL_TYPE   CS_DOUBLE

CS_THR_MIN

#define CS_THR_MIN   128

CS_UINT_TYPE

#define CS_UINT_TYPE   CS_UINT32

CS_UNUSED

#define CS_UNUSED

(

x

)

Value:

(void)(x)

CS_V_CONSTANT

#define CS_V_CONSTANT   static const

dcgettext

#define dcgettext	(		Domain,
			String,
			Type )

Value:

(String)

DEPRECATED

#define DEPRECATED

dgettext

#define dgettext	(		Domain,
			String )

Value:

(String)

END_C_DECLS

#define END_C_DECLS

false

#define false   0

gettext

#define gettext

(

String

)

Value:

(String)

inline

#define inline

N_

#define N_

(

String

)

Value:

String

restrict

#define restrict

textdomain

#define textdomain

(

String

)

Value:

(String)

true

#define true   1

Typedef Documentation

cs_byte_t

typedef char cs_byte_t

cs_coord_3_t

typedef cs_coord_t cs_coord_3_t[3]

cs_coord_t

typedef double cs_coord_t

cs_destructor_t

typedef void * cs_destructor_t(void *s)

Destroy a given structure.

Parameters

[in,out]

s

pointer to a structure cast on-the-fly

Returns

a null pointer

cs_dreal_3_t

typedef cs_dreal_t cs_dreal_3_t[3]

cs_dreal_t

typedef double cs_dreal_t

cs_flag_t

typedef unsigned short int cs_flag_t

cs_gnum_t

typedef unsigned cs_gnum_t

global mesh entity number

Global mesh-entity numbers are strictly positive (1 to n based) integers, so they are declared as a form of unsigned integer. Such a number is unique across MPI ranks; 2 mesh elements on different ranks share the same number if and only if they are local instances of the same global element (such as shared faces or vertices on rank boundaries). A value of 0 is commonly used to mark undefined (or not yet defined) element ids in various pre or post-processing stages.

cs_lnum_2_t

typedef cs_lnum_t cs_lnum_2_t[2]

vector of 2 local mesh-entity ids

cs_lnum_3_t

typedef cs_lnum_t cs_lnum_3_t[3]

cs_lnum_t

typedef int cs_lnum_t

local mesh entity id

Local mesh-entity ids are signed integers, and be either 0 to n-1 or 1 to n based. When 0-based, the id prefix or postfix is preferred for associated variable names, while num is preferred when 1-based. In C code, using this type is recommended over using simple int integers, as 64-bit variants could be used in the future for shared-memory machines with large memory. This type should not be used to declare identifiers which are not mesh entities, such as groups, fields, or any other entity whose count does not depend on mesh size, so as not to pollute the readability and comprehensibility of the code.

cs_nreal_3_t

typedef cs_nreal_t cs_nreal_3_t[3]

cs_nreal_t

typedef double cs_nreal_t

cs_real_10_t

typedef cs_real_t cs_real_10_t[10]

cs_real_23_t

typedef cs_real_t cs_real_23_t[2][3]

cs_real_2_t

typedef cs_real_t cs_real_2_t[2]

vector of 2 floating-point values

cs_real_332_t

typedef cs_real_33_t cs_real_332_t[2]

vector of 2 3x3 matrices of floating-point values

cs_real_333_t

typedef cs_real_t cs_real_333_t[3][3][3]

cs_real_33_t

typedef cs_real_t cs_real_33_t[3][3]

3x3 matrix of floating-point values

cs_real_34_t

typedef cs_real_t cs_real_34_t[3][4]

cs_real_3_t

typedef cs_real_t cs_real_3_t[3]

vector of 3 floating-point values

cs_real_4_t

typedef cs_real_t cs_real_4_t[4]

vector of 4 floating-point values

cs_real_63_t

typedef cs_real_t cs_real_63_t[6][3]

cs_real_662_t

typedef cs_real_66_t cs_real_662_t[2]

cs_real_66_t

typedef cs_real_t cs_real_66_t[6][6]

6x6 matrix of floating-point values

cs_real_69_t

typedef cs_real_t cs_real_69_t[6][9]

cs_real_6_t

typedef cs_real_t cs_real_6_t[6]

vector of 6 floating-point values

cs_real_99_t

typedef cs_real_t cs_real_99_t[9][9]

cs_real_9_t

typedef cs_real_t cs_real_9_t[9]

cs_real_t

typedef double cs_real_t

Floating-point value.

cs_rreal_3_t

typedef cs_rreal_t cs_rreal_3_t[3]

cs_rreal_t

typedef double cs_rreal_t

Enumeration Type Documentation

cs_datatype_t

enum cs_datatype_t

Enumerator
CS_DATATYPE_NULL
CS_CHAR
CS_FLOAT
CS_DOUBLE
CS_UINT16
CS_INT32
CS_INT64
CS_UINT32
CS_UINT64

cs_interlace_t

enum cs_interlace_t

Enumerator
CS_INTERLACE
CS_NO_INTERLACE

Function Documentation

cs_align()

cs_lnum_t cs_align ( cs_lnum_t i, cs_lnum_t m )

inlinestatic

Given a base index i, return the next index aligned with a size m.

This index is computed as follows:

if i > 0: ((i - 1) / m + 1) * m if i = 0: 0

Parameters

[in]	i	base index
[in]	m	block size to align with

Returns

aligned index

cs_get_thread_id()

int cs_get_thread_id ( void )

inlinestatic

Retrieve the associated thread id (0 if no OpenMP or if outside an OpenMP region)

Returns

the id of the OpenMP thread

Variable Documentation

cs_datatype_name

const char* cs_datatype_name[]

extern

cs_datatype_size

const size_t cs_datatype_size[]

extern

cs_empty_string

const char cs_empty_string[]

extern

cs_glob_n_ranks

int cs_glob_n_ranks

extern

Number of processes in communicator

cs_glob_n_threads

int cs_glob_n_threads

extern

cs_glob_node_n_ranks

int cs_glob_node_n_ranks

extern

Number of ranks on node of main MPI communicator

cs_glob_node_rank_id

int cs_glob_node_rank_id

extern

Rank on node in main MPI communicator

cs_glob_rank_id

int cs_glob_rank_id

extern

Rank of process in communicator