cs_numbering.h File Reference

#include "base/cs_defs.h"
#include "base/cs_base.h"
#include "base/cs_log.h"

Include dependency graph for cs_numbering.h:

Go to the source code of this file.

Data Structures
struct	cs_numbering_t

Macros
#define	CS_NUMBERING_SIMD_SIZE   4 /* Most current platforms */

Enumerations
enum	cs_numbering_type_t { CS_NUMBERING_DEFAULT , CS_NUMBERING_VECTORIZE , CS_NUMBERING_THREADS }

Functions
cs_numbering_t *	cs_numbering_create_default (cs_lnum_t n_elts)
	Create a default numbering information structure.
cs_numbering_t *	cs_numbering_create_vectorized (cs_lnum_t n_elts, int vector_size)
	Create a default numbering information structure in case of vectorization.
cs_numbering_t *	cs_numbering_create_threaded (int n_threads, int n_groups, cs_lnum_t group_index[])
	Create a default numbering information structure in case of threading.
void	cs_numbering_destroy (cs_numbering_t **numbering)
	Destroy a numbering information structure.
void	cs_numbering_log_info (cs_log_t log, const char *description, const cs_numbering_t *numbering)
	Log information relative to a cs_numbering_t structure.
void	cs_numbering_dump (const cs_numbering_t *numbering)
	Dump a cs_numbering_t structure.

Variables
const char *	cs_numbering_type_name []

Macro Definition Documentation

CS_NUMBERING_SIMD_SIZE

#define CS_NUMBERING_SIMD_SIZE   4 /* Most current platforms */

Enumeration Type Documentation

cs_numbering_type_t

enum cs_numbering_type_t

Enumerator
CS_NUMBERING_DEFAULT
CS_NUMBERING_VECTORIZE
CS_NUMBERING_THREADS

Function Documentation

cs_numbering_create_default()

cs_numbering_t * cs_numbering_create_default

(

cs_lnum_t

n_elts

)

Create a default numbering information structure.

Parameters

[in]

n_elts

number of associated elements

Returns

pointer to created cs_numbering_t structure

cs_numbering_create_threaded()

cs_numbering_t * cs_numbering_create_threaded	(	int	n_threads,
		int	n_groups,
		cs_lnum_t	group_index[] )

Create a default numbering information structure in case of threading.

Parameters

[in]	n_threads	number of threads
[in]	n_groups	number of groups
[in]	group_index	group_index[thread_id*group_id*2 + group_id*2] and group_index[thread_id*group_id*2 + group_id*2 +1] define the start and end ids for entities in a given group and thread; (size: n_groups *2 * n_threads)

Returns

pointer to created cs_numbering_t structure

cs_numbering_create_vectorized()

cs_numbering_t * cs_numbering_create_vectorized	(	cs_lnum_t	n_elts,
		int	vector_size )

Create a default numbering information structure in case of vectorization.

Parameters

[in]	n_elts	number of associated elements
[in]	vector_size	vector size used for this vectorization

Returns

pointer to created cs_numbering_t structure

cs_numbering_destroy()

void cs_numbering_destroy

(

cs_numbering_t **

numbering

)

Destroy a numbering information structure.

Parameters

[in,out]	numbering	pointer to cs_numbering_t structure pointer (or NULL)
[in,out]	numbering	pointer to cs_numbering_t structure pointer (or nullptr)

cs_numbering_dump()

void cs_numbering_dump

(

const cs_numbering_t *

numbering

)

Dump a cs_numbering_t structure.

Parameters

[in]	numbering	pointer to cs_numbering_t structure (or NULL)
[in]	numbering	pointer to cs_numbering_t structure (or nullptr)

cs_numbering_log_info()

void cs_numbering_log_info	(	cs_log_t	log,
		const char *	description,
		const cs_numbering_t *	numbering )

Log information relative to a cs_numbering_t structure.

Parameters

[in]	log	log type
[in]	description	description of numbering type
[in]	numbering	pointer to cs_numbering_t structure (or NULL)
[in]	log	log type
[in]	description	description of numbering type
[in]	numbering	pointer to cs_numbering_t structure (or nullptr)

Variable Documentation

cs_numbering_type_name

const char* cs_numbering_type_name[]

extern