cs_array.h File Reference

#include <string.h>
#include "cs_defs.h"

Include dependency graph for cs_array.h:

Go to the source code of this file.

Macros
#define	CS_ARRAY_SUBSET_NULL   -1
#define	CS_ARRAY_SUBSET_IN   0
#define	CS_ARRAY_SUBSET_OUT   1
#define	CS_ARRAY_SUBSET_INOUT   2

Functions
void	cs_array_bool_fill_true (cs_lnum_t size, bool a[restrict])
	Assign true to all elements of an array. Case of an array of booleans. More...
void	cs_array_bool_fill_false (cs_lnum_t size, bool a[restrict])
	Assign false to all elements of an array. Case of an array of booleans. More...
void	cs_array_flag_fill_zero (cs_lnum_t size, cs_flag_t a[restrict])
	Assign zero to all elements of an array. Case of a cs_flag_t array. More...
void	cs_array_lnum_fill_zero (cs_lnum_t size, cs_lnum_t a[restrict])
	Assign zero to all elements of an array. Case of a cs_lnum_t array. More...
void	cs_array_lnum_set_value (cs_lnum_t size, cs_lnum_t num, cs_lnum_t a[restrict])
	Assign the value "num" to all elements of an array. Case of a cs_lnum_t array. More...
void	cs_array_lnum_set_value_on_subset (cs_lnum_t n_elts, const cs_lnum_t elt_ids[], cs_lnum_t num, cs_lnum_t a[restrict])
	Assign the value "num" to an array on a selected subset of elements. if elt_ids = NULL, then one recovers the function cs_array_lnum_set_value. More...
void	cs_array_real_copy_subset (cs_lnum_t n_elts, int stride, const cs_lnum_t elt_ids[], int mode, const cs_real_t ref[], cs_real_t dest[])
	Copy an array ("ref") into another array ("dest") on possibly only a part of the array(s). Array with stride > 1 are assumed to be interlaced. The subset of elements on which working is defined by "elt_ids". The way to apply the subset is defined with the parameter "mode" as follows: More...
void	cs_array_real_copy (cs_lnum_t size, const cs_real_t src[], cs_real_t dest[restrict])
	Copy real values from an array to another of the same dimensions. More...
void	cs_array_real_scale (cs_lnum_t n_elts, int stride, const cs_lnum_t *elt_ids, cs_real_t scaling_factor, cs_real_t dest[restrict])
	Multiply each value by a scaling factor s.t. dest *= scaling_factor If elt_ids is not NULL, one applies an indirection. A stride can also be applied. One assumes an interlaced array. More...
void	cs_array_real_set_value (cs_lnum_t n_elts, int stride, const cs_real_t ref_val[], cs_real_t *a)
	Assign a constant value of dim "stride" to an interlaced array sharing the same stride. More...
void	cs_array_real_set_wvalue (cs_lnum_t n_elts, int stride, const cs_real_t ref_val[], const cs_real_t weight[], cs_real_t *a)
	Assign a weighted constant value of dim "stride" to an interlaced array sharing the same stride. Apply a weight for each element. This weight is constant for each component of an element. More...
void	cs_array_real_set_value_on_subset (cs_lnum_t n_elts, int stride, const cs_lnum_t elt_ids[], const cs_real_t ref_val[], cs_real_t *a)
	Assign a constant value of dim "stride" to an interlaced array sharing the same stride. Only a subset of elements are considered. If elt_ids = NULL, then one recovers the function cs_array_real_set_value. More...
void	cs_array_real_set_wvalue_on_subset (cs_lnum_t n_elts, int stride, const cs_lnum_t elt_ids[], const cs_real_t ref_val[], const cs_real_t weight[], cs_real_t *a)
	Assign a weighted constant value of dim "stride" to an interlaced array sharing the same stride. Only a subset of elements are considered. If elt_ids = NULL, then one recovers the function cs_array_real_set_wvalue Apply a weight for each element. This weight is constant for each component of an element. More...
void	cs_array_real_set_scalar (cs_lnum_t n_elts, cs_real_t ref_val, cs_real_t a[restrict])
	Assign a constant scalar value to an array. More...
void	cs_array_real_set_wscalar (cs_lnum_t n_elts, cs_real_t ref_val, const cs_real_t weight[], cs_real_t a[restrict])
	Assign a weighted constant scalar value to an array. The weight array has the same size as the array "a". More...
void	cs_array_real_set_scalar_on_subset (cs_lnum_t n_elts, const cs_lnum_t elt_ids[], cs_real_t ref_val, cs_real_t a[restrict])
	Assign a constant scalar value to an array on a selected subset of elements. If elt_ids = NULL, then one recovers the function cs_array_real_set_scalar. More...
void	cs_array_real_set_wscalar_on_subset (cs_lnum_t n_elts, const cs_lnum_t elt_ids[], cs_real_t ref_val, const cs_real_t weight[], cs_real_t a[restrict])
	Assign a weighted constant scalar value to an array on a selected subset of elements. If elt_ids = NULL, then one recovers the function cs_array_real_set_wscalar. More...
void	cs_array_real_set_vector (cs_lnum_t n_elts, const cs_real_t ref_val[3], cs_real_t *a)
	Assign a constant vector to an array of stride 3 which is interlaced. More...
void	cs_array_real_set_wvector (cs_lnum_t n_elts, const cs_real_t ref_val[3], const cs_real_t weight[], cs_real_t *a)
	Assign a weighted constant vector value to an interlaced array (of stride 3). The array of weights has the same size as the array "a". More...
void	cs_array_real_set_vector_on_subset (cs_lnum_t n_elts, const cs_lnum_t elt_ids[], const cs_real_t ref_val[3], cs_real_t a[])
	Assign a constant vector to an interlaced array (of stride 3) on a selected subset of elements. If elt_ids = NULL, then one recovers the function cs_array_real_set_vector. More...
void	cs_array_real_set_wvector_on_subset (cs_lnum_t n_elts, const cs_lnum_t elt_ids[], const cs_real_t ref_val[3], const cs_real_t weight[], cs_real_t *a)
	Assign a weighted constant vector value to an interlaced array (of stride 3). The subset selection is given by elt_ids. If NULL, then one recovers the function cs_array_real_set_wvector The array of weights has the same size as the array "a". More...
void	cs_array_real_set_tensor (cs_lnum_t n_elts, const cs_real_t ref_tens[3][3], cs_real_t *a)
	Assign a constant 3x3 tensor to an array (of stride 9) which is interlaced. More...
void	cs_array_real_set_tensor_on_subset (cs_lnum_t n_elts, const cs_lnum_t elt_ids[], const cs_real_t ref_tens[3][3], cs_real_t *a)
	Assign a constant 3x3 tensor to an interlaced array (of stride 9) on a subset of elements. If elt_ids = NULL, then one recovers the function cs_array_real_set_tensor. More...
void	cs_array_real_fill_zero (cs_lnum_t size, cs_real_t a[])
	Assign zero to all elements of an array. More...
void	cs_array_set_value_real (cs_lnum_t n_elts, cs_lnum_t dim, cs_real_t v, cs_real_t a[])
	Assign a constant value to an array (deprecated function). More...

Macro Definition Documentation

CS_ARRAY_SUBSET_IN

#define CS_ARRAY_SUBSET_IN   0

CS_ARRAY_SUBSET_INOUT

#define CS_ARRAY_SUBSET_INOUT   2

CS_ARRAY_SUBSET_NULL

#define CS_ARRAY_SUBSET_NULL   -1

CS_ARRAY_SUBSET_OUT

#define CS_ARRAY_SUBSET_OUT   1

Function Documentation

cs_array_bool_fill_false()

void cs_array_bool_fill_false	(	cs_lnum_t	size,
		bool	a[restrict]
	)

Assign false to all elements of an array. Case of an array of booleans.

Parameters

[in]	size	total number of elements to set
[in,out]	a	array to set

cs_array_bool_fill_true()

void cs_array_bool_fill_true	(	cs_lnum_t	size,
		bool	a[restrict]
	)

Assign true to all elements of an array. Case of an array of booleans.

Parameters

[in]	size	total number of elements to set
[in,out]	a	array to set

cs_array_flag_fill_zero()

void cs_array_flag_fill_zero	(	cs_lnum_t	size,
		cs_flag_t	a[restrict]
	)

Assign zero to all elements of an array. Case of a cs_flag_t array.

Parameters

[in]	size	total number of elements to set to zero
[in,out]	a	array of flags to set

cs_array_lnum_fill_zero()

void cs_array_lnum_fill_zero	(	cs_lnum_t	size,
		cs_lnum_t	a[restrict]
	)

Assign zero to all elements of an array. Case of a cs_lnum_t array.

Parameters

[in]	size	total number of elements to set to zero
[in,out]	a	array to set

cs_array_lnum_set_value()

void cs_array_lnum_set_value	(	cs_lnum_t	size,
		cs_lnum_t	num,
		cs_lnum_t	a[restrict]
	)

Assign the value "num" to all elements of an array. Case of a cs_lnum_t array.

Parameters

[in]	size	total number of elements to set
[in]	num	value to set
[in,out]	a	array to set

cs_array_lnum_set_value_on_subset()

void cs_array_lnum_set_value_on_subset	(	cs_lnum_t	n_elts,
		const cs_lnum_t	elt_ids[],
		cs_lnum_t	num,
		cs_lnum_t	a[restrict]
	)

Assign the value "num" to an array on a selected subset of elements. if elt_ids = NULL, then one recovers the function cs_array_lnum_set_value.

Parameters

[in]	n_elts	number of elements
[in]	elt_ids	list of ids in the subset or NULL (size: n_elts)
[in]	num	value to set
[in,out]	a	array to set

Assign the value "num" to an array on a selected subset of elements. if elt_ids = NULL, then one recovers the function cs_array_lnum_set_value.

Parameters

[in]	n_elts	number of elements
[in]	elt_ids	list of ids in the subset or NULL (size: n_elts)
[in]	num	value to set
[in,out]	a	array to set

cs_array_real_copy()

void cs_array_real_copy	(	cs_lnum_t	size,
		const cs_real_t	src[],
		cs_real_t	dest[restrict]
	)

Copy real values from an array to another of the same dimensions.

Parameters

[in]	size	number of elements * dimension
[in]	src	source array values (size: n_elts*dim)
[out]	dest	destination array values (size: n_elts*dim)

cs_array_real_copy_subset()

void cs_array_real_copy_subset	(	cs_lnum_t	n_elts,
		int	stride,
		const cs_lnum_t	elt_ids[],
		int	mode,
		const cs_real_t	ref[],
		cs_real_t	dest[]
	)

Copy an array ("ref") into another array ("dest") on possibly only a part of the array(s). Array with stride > 1 are assumed to be interlaced. The subset of elements on which working is defined by "elt_ids". The way to apply the subset is defined with the parameter "mode" as follows:

• Only the "ref" array if mode = 0 (CS_ARRAY_SUBSET_IN)
• Only the "dest" array if mode = 1 (CS_ARRAY_SUBSET_OUT)
• Both "ref" and "dest" arrays if mode = 2 (CS_ARRAY_SUBSET_INOUT)

It elt_ids = NULL or mode < 0 (CS_ARRAY_SUBSET_NULL), then the behavior is as cs_array_real_copy

One assumes that all arrays are allocated with a correct size.

Parameters

[in]	n_elts	number of elements in the array
[in]	stride	number of values for each element
[in]	mode	apply the subset ids to which array(s)
[in]	elt_ids	list of ids in the subset or NULL (size: n_elts)
[in]	ref	reference values to copy
[in,out]	dest	array storing values after applying the indirection

cs_array_real_fill_zero()

void cs_array_real_fill_zero	(	cs_lnum_t	size,
		cs_real_t	a[]
	)

Assign zero to all elements of an array.

Parameters

[in]	size	total number of elements to set to zero
[in,out]	a	array to set

cs_array_real_scale()

void cs_array_real_scale	(	cs_lnum_t	n_elts,
		int	stride,
		const cs_lnum_t *	elt_ids,
		cs_real_t	scaling_factor,
		cs_real_t	dest[restrict]
	)

Multiply each value by a scaling factor s.t. dest *= scaling_factor If elt_ids is not NULL, one applies an indirection. A stride can also be applied. One assumes an interlaced array.

Parameters

[in]	n_elts	number of elements
[in]	stride	number of values for each element
[in]	elt_ids	list of ids in the subset or NULL (size: n_elts)
[in]	scaling_factor	value of the scaling factor
[out]	dest	destination array values

cs_array_real_set_scalar()

void cs_array_real_set_scalar	(	cs_lnum_t	n_elts,
		cs_real_t	ref_val,
		cs_real_t	a[restrict]
	)

Assign a constant scalar value to an array.

Parameters

[in]	n_elts	number of elements
[in]	ref_val	value to assign
[in,out]	a	array to set

cs_array_real_set_scalar_on_subset()

void cs_array_real_set_scalar_on_subset	(	cs_lnum_t	n_elts,
		const cs_lnum_t	elt_ids[],
		cs_real_t	ref_val,
		cs_real_t	a[restrict]
	)

Assign a constant scalar value to an array on a selected subset of elements. If elt_ids = NULL, then one recovers the function cs_array_real_set_scalar.

Parameters

[in]	n_elts	number of elements
[in]	elt_ids	list of ids in the subset or NULL (size: n_elts)
[in]	ref_val	value to assign
[in,out]	a	array to set

cs_array_real_set_tensor()

void cs_array_real_set_tensor	(	cs_lnum_t	n_elts,
		const cs_real_t	ref_tens[3][3],
		cs_real_t *	a
	)

Assign a constant 3x3 tensor to an array (of stride 9) which is interlaced.

Parameters

[in]	n_elts	number of elements
[in]	ref_tens	tensor to assign
[in,out]	a	array to set

cs_array_real_set_tensor_on_subset()

void cs_array_real_set_tensor_on_subset	(	cs_lnum_t	n_elts,
		const cs_lnum_t	elt_ids[],
		const cs_real_t	ref_tens[3][3],
		cs_real_t *	a
	)

Assign a constant 3x3 tensor to an interlaced array (of stride 9) on a subset of elements. If elt_ids = NULL, then one recovers the function cs_array_real_set_tensor.

Parameters

[in]	n_elts	number of elements
[in]	elt_ids	list of ids defining the subset or NULL
[in]	ref_tens	tensor to assign
[in,out]	a	array to set

cs_array_real_set_value()

void cs_array_real_set_value	(	cs_lnum_t	n_elts,
		int	stride,
		const cs_real_t	ref_val[],
		cs_real_t *	a
	)

Assign a constant value of dim "stride" to an interlaced array sharing the same stride.

Parameters

[in]	n_elts	number of elements
[in]	stride	number of values for each element
[in]	ref_val	list of values to assign (size: stride)
[in,out]	a	array to set (size: n_elts*stride)

cs_array_real_set_value_on_subset()

void cs_array_real_set_value_on_subset	(	cs_lnum_t	n_elts,
		int	stride,
		const cs_lnum_t	elt_ids[],
		const cs_real_t	ref_val[],
		cs_real_t *	a
	)

Assign a constant value of dim "stride" to an interlaced array sharing the same stride. Only a subset of elements are considered. If elt_ids = NULL, then one recovers the function cs_array_real_set_value.

Parameters

[in]	n_elts	number of elements
[in]	stride	number of values for each element
[in]	elt_ids	list of ids in the subset or NULL (size: n_elts)
[in]	ref_val	list of values to assign (size: stride)
[in,out]	a	array to set (size >= n_elts * stride)

cs_array_real_set_vector()

void cs_array_real_set_vector	(	cs_lnum_t	n_elts,
		const cs_real_t	ref_val[3],
		cs_real_t *	a
	)

Assign a constant vector to an array of stride 3 which is interlaced.

Parameters

[in]	n_elts	number of elements
[in]	ref_val	vector to assign
[in,out]	a	array to set

cs_array_real_set_vector_on_subset()

void cs_array_real_set_vector_on_subset	(	cs_lnum_t	n_elts,
		const cs_lnum_t	elt_ids[],
		const cs_real_t	ref_val[3],
		cs_real_t	a[]
	)

Assign a constant vector to an interlaced array (of stride 3) on a selected subset of elements. If elt_ids = NULL, then one recovers the function cs_array_real_set_vector.

Parameters

[in]	n_elts	number of elements
[in]	elt_ids	list of ids in the subset or NULL (size: n_elts)
[in]	ref_val	vector to assign
[in,out]	a	array to set

cs_array_real_set_wscalar()

void cs_array_real_set_wscalar	(	cs_lnum_t	n_elts,
		cs_real_t	ref_val,
		const cs_real_t	weight[],
		cs_real_t	a[restrict]
	)

Assign a weighted constant scalar value to an array. The weight array has the same size as the array "a".

Parameters

[in]	n_elts	number of elements
[in]	ref_val	value to assign
[in]	weight	values of the weight to apply
[in,out]	a	array to set

cs_array_real_set_wscalar_on_subset()

void cs_array_real_set_wscalar_on_subset	(	cs_lnum_t	n_elts,
		const cs_lnum_t	elt_ids[],
		cs_real_t	ref_val,
		const cs_real_t	weight[],
		cs_real_t	a[restrict]
	)

Assign a weighted constant scalar value to an array on a selected subset of elements. If elt_ids = NULL, then one recovers the function cs_array_real_set_wscalar.

Parameters

[in]	n_elts	number of elements
[in]	elt_ids	list of ids in the subset or NULL (size: n_elts)
[in]	ref_val	value to assign
[in]	weight	values of weights to apply
[in,out]	a	array to set

cs_array_real_set_wvalue()

void cs_array_real_set_wvalue	(	cs_lnum_t	n_elts,
		int	stride,
		const cs_real_t	ref_val[],
		const cs_real_t	weight[],
		cs_real_t *	a
	)

Assign a weighted constant value of dim "stride" to an interlaced array sharing the same stride. Apply a weight for each element. This weight is constant for each component of an element.

Parameters

[in]	n_elts	number of elements
[in]	stride	number of values for each element
[in]	ref_val	list of values to assign (size: stride)
[in]	weight	values of the weight to apply (size: n_elts)
[in,out]	a	array to set (size: n_elts*stride)

cs_array_real_set_wvalue_on_subset()

void cs_array_real_set_wvalue_on_subset	(	cs_lnum_t	n_elts,
		int	stride,
		const cs_lnum_t	elt_ids[],
		const cs_real_t	ref_val[],
		const cs_real_t	weight[],
		cs_real_t *	a
	)

Assign a weighted constant value of dim "stride" to an interlaced array sharing the same stride. Only a subset of elements are considered. If elt_ids = NULL, then one recovers the function cs_array_real_set_wvalue Apply a weight for each element. This weight is constant for each component of an element.

Parameters

[in]	n_elts	number of elements
[in]	stride	number of values for each element
[in]	elt_ids	list of ids in the subset or NULL (size: n_elts)
[in]	ref_val	list of values to assign (size: stride)
[in]	weight	values of the weight to apply (size >= n_elts)
[in,out]	a	array to set (size >= n_elts*stride)

cs_array_real_set_wvector()

void cs_array_real_set_wvector	(	cs_lnum_t	n_elts,
		const cs_real_t	ref_val[3],
		const cs_real_t	weight[],
		cs_real_t *	a
	)

Assign a weighted constant vector value to an interlaced array (of stride 3). The array of weights has the same size as the array "a".

Parameters

[in]	n_elts	number of elements
[in]	ref_val	vector to assign
[in]	weight	values of the weight to apply
[in,out]	a	array to set

cs_array_real_set_wvector_on_subset()

void cs_array_real_set_wvector_on_subset	(	cs_lnum_t	n_elts,
		const cs_lnum_t	elt_ids[],
		const cs_real_t	ref_val[3],
		const cs_real_t	weight[],
		cs_real_t *	a
	)

Assign a weighted constant vector value to an interlaced array (of stride 3). The subset selection is given by elt_ids. If NULL, then one recovers the function cs_array_real_set_wvector The array of weights has the same size as the array "a".

Parameters

[in]	n_elts	number of elements
[in]	elt_ids	list of ids in the subset or NULL (size: n_elts)
[in]	ref_val	vector to assign
[in]	weight	values of the weight to apply
[in,out]	a	array to set

cs_array_set_value_real()

void cs_array_set_value_real	(	cs_lnum_t	n_elts,
		cs_lnum_t	dim,
		cs_real_t	v,
		cs_real_t	a[]
	)

Assign a constant value to an array (deprecated function).

Parameters

[in]	n_elts	number of associated elements
[in]	dim	associated dimension
[in]	v	value to assign
[out]	a	array values (size: n_elts*dim)