#include "cs_defs.h"
#include <assert.h>
#include <math.h>

Include dependency graph for cs_math.h:

Enumerations
enum	cs_math_sym_tensor_component_t { XX, YY, ZZ, XY, YZ, XZ }

Functions
void	cs_math_set_machine_epsilon (void)
	Compute the value related to the machine precision. More...

double	cs_math_get_machine_epsilon (void)
	Get the value related to the machine precision. More...

void	cs_math_3_length_unitv (const cs_real_t xa[3], const cs_real_t xb[3], cs_real_t *len, cs_real_3_t unitv)
	Compute the length (Euclidean norm) between two points xa and xb in a Cartesian coordinate system of dimension 3. More...

void	cs_math_sym_33_eigen (const cs_real_t m[6], cs_real_t eig_vals[3])
	Compute all eigenvalues of a 3x3 symmetric matrix with symmetric storage. More...

void	cs_math_33_eigen (const cs_real_t m[3][3], cs_real_t eig_ratio, cs_real_t eig_max)
	Compute max/min eigenvalues ratio and max. eigenvalue of a 3x3 symmetric matrix with non-symmetric storage. More...

double	cs_math_surftri (const cs_real_t xv[3], const cs_real_t xe[3], const cs_real_t xf[3])
	Compute the area of the convex_hull generated by 3 points. This corresponds to the computation of the surface of a triangle. More...

double	cs_math_voltet (const cs_real_t xv[3], const cs_real_t xe[3], const cs_real_t xf[3], const cs_real_t xc[3])
	Compute the volume of the convex_hull generated by 4 points. This is equivalent to the computation of the volume of a tetrahedron. More...

void	cs_math_33_eig_val_vec (const cs_real_t m_in[3][3], const cs_real_t tol_err, cs_real_t eig_val[restrict 3], cs_real_t eig_vec[restrict 3][3])
	Evaluate eigenvalues and eigenvectors of a real symmetric matrix m1[3,3]: m1m2 = lambdam2. More...

void	cs_math_fact_lu (cs_lnum_t n_blocks, const int b_size, const cs_real_t a, cs_real_t a_lu)
	Compute LU factorization of an array of dense matrices of identical size. More...

void	cs_math_fw_and_bw_lu (const cs_real_t a_lu[], const int n, cs_real_t x[], const cs_real_t b[])
	Block Jacobi utilities. Compute forward and backward to solve an LU P*P system. More...

Variables
const cs_real_t	cs_math_zero_threshold

const cs_real_t	cs_math_1ov3

const cs_real_t	cs_math_2ov3

const cs_real_t	cs_math_4ov3

const cs_real_t	cs_math_5ov3

const cs_real_t	cs_math_1ov6

const cs_real_t	cs_math_1ov12

const cs_real_t	cs_math_1ov24

const cs_real_t	cs_math_epzero

const cs_real_t	cs_math_infinite_r

const cs_real_t	cs_math_big_r

const cs_real_t	cs_math_pi

Enumeration Type Documentation

◆ cs_math_sym_tensor_component_t

enum cs_math_sym_tensor_component_t

Enumerator
XX
YY
ZZ
XY
YZ
XZ

Function Documentation

◆ cs_math_33_eig_val_vec()

void cs_math_33_eig_val_vec	(	const cs_real_t	m_in[3][3],
		const cs_real_t	tol_err,
		cs_real_t	eig_val[restrict 3],
		cs_real_t	eig_vec[restrict 3][3]
	)

Evaluate eigenvalues and eigenvectors of a real symmetric matrix m1[3,3]: m1*m2 = lambda*m2.

Use of Jacobi method for symmetric matrices (adapted from the book Numerical Recipes in C, Chapter 11.1)

Parameters

[in]	m_in	matrix of 3x3 real values (initial)
[in]	tol_err	absolute tolerance (sum of off-diagonal elements)
[out]	eig_val	vector of 3 real values (eigenvalues)
[out]	eig_vec	matrix of 3x3 real values (eigenvectors)

◆ cs_math_33_eigen()

void cs_math_33_eigen	(	const cs_real_t	m[3][3],
		cs_real_t *	eig_ratio,
		cs_real_t *	eig_max
	)

Compute max/min eigenvalues ratio and max. eigenvalue of a 3x3 symmetric matrix with non-symmetric storage.

Based on: Oliver K. Smith "eigenvalues of a symmetric 3x3 matrix", Communication of the ACM (April 1961) (Wikipedia article entitled "Eigenvalue algorithm")

Parameters

[in]	m	3x3 matrix
[out]	eig_ratio	max/min
[out]	eig_max	max. eigenvalue

◆ cs_math_3_length_unitv()

void cs_math_3_length_unitv	(	const cs_real_t	xa[3],
		const cs_real_t	xb[3],
		cs_real_t *	len,
		cs_real_3_t	unitv
	)

inline

Compute the length (Euclidean norm) between two points xa and xb in a Cartesian coordinate system of dimension 3.

Parameters

[in]	xa	coordinate of the first extremity
[in]	xb	coordinate of the second extremity
[out]	len	pointer to the length of the vector va -> vb
[out]	unitv	unitary vector along xa -> xb
[in]	xa	coordinate of the first extremity
[in]	xb	coordinate of the second extremity
[out]	len	pointer to the length of the vector va -> vb
[out]	unitv	unitary vector along va -> vb

◆ cs_math_fact_lu()

void cs_math_fact_lu	(	cs_lnum_t	n_blocks,
		int	b_size,
		const cs_real_t *	a,
		cs_real_t *	a_lu
	)

Compute LU factorization of an array of dense matrices of identical size.

Parameters

[in]	n_blocks	number of blocks
[in]	b_size	block size
[in]	a	matrix blocks
[out]	a_lu	LU factorizations of matrix blocks

◆ cs_math_fw_and_bw_lu()

void cs_math_fw_and_bw_lu	(	const cs_real_t	a_lu[],
		int	n,
		cs_real_t	x[],
		const cs_real_t	b[]
	)

Block Jacobi utilities. Compute forward and backward to solve an LU P*P system.

Parameters

[in]	a_lu	matrix LU factorization
[in]	n	matrix size
[out]	x	solution
[out]	b	right hand side

◆ cs_math_get_machine_epsilon()

double cs_math_get_machine_epsilon ( void )

Get the value related to the machine precision.

◆ cs_math_set_machine_epsilon()

void cs_math_set_machine_epsilon ( void )

Compute the value related to the machine precision.

◆ cs_math_surftri()

double cs_math_surftri	(	const cs_real_t	xv[3],
		const cs_real_t	xe[3],
		const cs_real_t	xf[3]
	)

inline

Compute the area of the convex_hull generated by 3 points. This corresponds to the computation of the surface of a triangle.

Parameters

[in]	xv	coordinates of the first vertex
[in]	xe	coordinates of the second vertex
[in]	xf	coordinates of the third vertex

Returns: the surface of a triangle

◆ cs_math_sym_33_eigen()

void cs_math_sym_33_eigen	(	const cs_real_t	m[6],
		cs_real_t	eig_vals[3]
	)

Compute all eigenvalues of a 3x3 symmetric matrix with symmetric storage.

Based on: Oliver K. Smith "eigenvalues of a symmetric 3x3 matrix", Communication of the ACM (April 1961) (Wikipedia article entitled "Eigenvalue algorithm")

Parameters

[in]	m	3x3 symmetric matrix (m11, m22, m33, m12, m23, m13)
[out]	eig_vals	size 3 vector

◆ cs_math_voltet()

double cs_math_voltet	(	const cs_real_t	xv[3],
		const cs_real_t	xe[3],
		const cs_real_t	xf[3],
		const cs_real_t	xc[3]
	)

Compute the volume of the convex_hull generated by 4 points. This is equivalent to the computation of the volume of a tetrahedron.

Parameters

[in]	xv	coordinates of the first vertex
[in]	xe	coordinates of the second vertex
[in]	xf	coordinates of the third vertex
[in]	xc	coordinates of the fourth vertex

Returns: the volume of the tetrahedron.

Variable Documentation

◆ cs_math_1ov12

const cs_real_t cs_math_1ov12

◆ cs_math_1ov24

const cs_real_t cs_math_1ov24

◆ cs_math_1ov3

const cs_real_t cs_math_1ov3

◆ cs_math_1ov6

const cs_real_t cs_math_1ov6

◆ cs_math_2ov3

const cs_real_t cs_math_2ov3

◆ cs_math_4ov3

const cs_real_t cs_math_4ov3

◆ cs_math_5ov3

const cs_real_t cs_math_5ov3

◆ cs_math_big_r

const cs_real_t cs_math_big_r

◆ cs_math_epzero

const cs_real_t cs_math_epzero

◆ cs_math_infinite_r

const cs_real_t cs_math_infinite_r

◆ cs_math_pi

const cs_real_t cs_math_pi

◆ cs_math_zero_threshold

const cs_real_t cs_math_zero_threshold

Enumerations

Functions

Variables

Enumeration Type Documentation

◆ cs_math_sym_tensor_component_t

Function Documentation

◆ cs_math_33_eig_val_vec()

◆ cs_math_33_eigen()

◆ cs_math_3_length_unitv()

◆ cs_math_fact_lu()

◆ cs_math_fw_and_bw_lu()

◆ cs_math_get_machine_epsilon()

◆ cs_math_set_machine_epsilon()

◆ cs_math_surftri()

◆ cs_math_sym_33_eigen()

◆ cs_math_voltet()

Variable Documentation

◆ cs_math_1ov12

◆ cs_math_1ov24

◆ cs_math_1ov3

◆ cs_math_1ov6

◆ cs_math_2ov3

◆ cs_math_4ov3

◆ cs_math_5ov3

◆ cs_math_big_r

◆ cs_math_epzero

◆ cs_math_infinite_r

◆ cs_math_pi

◆ cs_math_zero_threshold