#include "cs_cdo.h"
#include "cs_param.h"
#include "cs_cdo_connect.h"
#include "cs_cdo_quantities.h"
#include "cs_time_step.h"

Include dependency graph for cs_property.h:

Enumerations
enum	cs_property_type_t { CS_PROPERTY_ISO, CS_PROPERTY_ORTHO, CS_PROPERTY_ANISO, CS_PROPERTY_N_TYPES }

Functions
void	cs_property_set_shared_pointers (const cs_cdo_quantities_t quant, const cs_cdo_connect_t connect, const cs_time_step_t *time_step)
	Set shared pointers to main domain members. More...

void	cs_property_set_timer_stats (int level)
	Initialize cs_timer_stats_t structure for monitoring purpose. More...

cs_property_t *	cs_property_create (const char name, const char key_type, int n_subdomains)
	Create and initialize a new property structure. More...

cs_property_t *	cs_property_free (cs_property_t *pty)
	Free a cs_property_t structure. More...

bool	cs_property_check_name (const cs_property_t pty, const char ref_name)
	Check if the given property has the name ref_name. More...

bool	cs_property_is_uniform (const cs_property_t *pty)
	returns true if the property is uniform, otherwise false More...

const char *	cs_property_get_name (const cs_property_t *pty)
	Retrieve the name of a property. More...

cs_property_type_t	cs_property_get_type (const cs_property_t *pty)
	Retrieve the type of a property. More...

void	cs_property_summary (const cs_property_t *pty)
	Print a summary of a cs_property_t structure. More...

void	cs_property_def_by_value (cs_property_t pty, const char ml_name, const char *key_val)
	Define a cs_property_t structure by value for entities attached to the mesh location named ml_name. More...

void	cs_property_iso_def_by_value (cs_property_t pty, const char ml_name, double val)
	Define an isotropic cs_property_t structure by value for entities attached to the mesh location named ml_name. More...

void	cs_property_ortho_def_by_value (cs_property_t pty, const char ml_name, const double val[])
	Define orthotropic cs_property_t structure by value for entities attached to the mesh location named ml_name. More...

void	cs_property_aniso_def_by_value (cs_property_t pty, const char ml_name, const double tens[3][3])
	Define an anisotropic cs_property_t structure by value for entities attached to the mesh location named ml_name. More...

void	cs_property_def_by_analytic (cs_property_t pty, const char ml_name, cs_analytic_func_t *func)
	Define a cs_property_t structure thanks to an analytic function in a subdomain attached to the mesh location named ml_name. More...

void	cs_property_def_by_law (cs_property_t pty, const char ml_name, const void context, cs_onevar_law_func_t func)
	Define a cs_property_t structure thanks to law depending on one scalar variable in a subdomain attached to the mesh location named ml_name. More...

void	cs_property_def_by_twovar_law (cs_property_t pty, const char ml_name, const void context, cs_twovar_law_func_t func)
	Define a cs_property_t structure thanks to a law depending on two scalars variables in a subdomain attached to the mesh location named ml_name. More...

void	cs_property_def_by_scavec_law (cs_property_t pty, const char ml_name, const void context, cs_scavec_law_func_t func)
	Define a cs_property_t structure by a law (using as arguments a scalar and a vector) for entities attached to the mesh location named ml_name. More...

void	cs_property_def_by_array (cs_property_t pty, cs_desc_t desc, cs_real_t array)
	Define a cs_property_t structure thanks to an array of values. More...

void	cs_property_set_array (cs_property_t pty, cs_desc_t desc, cs_real_t array)
	Set the "array" member of a cs_property_t structure. More...

void	cs_property_set_second_array (cs_property_t pty, cs_desc_t desc, cs_real_t array)
	Set the second "array" member of a cs_property_t structure. More...

void	cs_property_get_cell_tensor (cs_lnum_t c_id, const cs_property_t pty, bool do_inversion, cs_real_3_t tensor)
	Compute the value of the tensor attached a property at the cell center. More...

cs_real_t	cs_property_get_cell_value (cs_lnum_t c_id, const cs_property_t *pty)
	Compute the value of a property at the cell center. More...

void	cs_property_get_fourier (const cs_property_t *pty, double dt, cs_real_t fourier[])
	Compute the Fourier number in each cell. More...

Enumeration Type Documentation

◆ cs_property_type_t

enum cs_property_type_t

Enumerator
CS_PROPERTY_ISO
CS_PROPERTY_ORTHO
CS_PROPERTY_ANISO
CS_PROPERTY_N_TYPES

Function Documentation

◆ cs_property_aniso_def_by_value()

void cs_property_aniso_def_by_value	(	cs_property_t *	pty,
		const char *	ml_name,
		const double	tens[3][3]
	)

Define an anisotropic cs_property_t structure by value for entities attached to the mesh location named ml_name.

Parameters

[in,out]	pty	pointer to a cs_property_t structure
[in]	ml_name	name of the related mesh location
[in]	tens	values to set (3x3 tensor)

◆ cs_property_check_name()

bool cs_property_check_name	(	const cs_property_t *	pty,
		const char *	ref_name
	)

Check if the given property has the name ref_name.

Parameters

[in]	pty	pointer to a cs_property_t structure to test
[in]	ref_name	name of the property to find

Returns: true if the name of the property is ref_name otherwise false

◆ cs_property_create()

cs_property_t* cs_property_create	(	const char *	name,
		const char *	key_type,
		int	n_subdomains
	)

Create and initialize a new property structure.

Parameters

[in]	name	name of the property
[in]	key_type	keyname of the type of property
[in]	n_subdomains	piecewise definition on n_subdomains

Returns: a pointer to a new allocated cs_property_t structure

◆ cs_property_def_by_analytic()

void cs_property_def_by_analytic	(	cs_property_t *	pty,
		const char *	ml_name,
		cs_analytic_func_t *	func
	)

Define a cs_property_t structure thanks to an analytic function in a subdomain attached to the mesh location named ml_name.

Parameters

[in,out]	pty	pointer to a cs_property_t structure
[in]	ml_name	name of the related mesh location
[in]	func	pointer to a cs_analytic_func_t function

◆ cs_property_def_by_array()

void cs_property_def_by_array	(	cs_property_t *	pty,
		cs_desc_t	desc,
		cs_real_t *	array
	)

Define a cs_property_t structure thanks to an array of values.

Parameters

[in,out]	pty	pointer to a cs_property_t structure
[in]	desc	information about this array
[in]	array	pointer to an array

◆ cs_property_def_by_law()

void cs_property_def_by_law	(	cs_property_t *	pty,
		const char *	ml_name,
		const void *	context,
		cs_onevar_law_func_t *	func
	)

Define a cs_property_t structure thanks to law depending on one scalar variable in a subdomain attached to the mesh location named ml_name.

Parameters

[in,out]	pty	pointer to a cs_property_t structure
[in]	ml_name	name of the related mesh location
[in]	context	pointer to a structure (may be NULL)
[in]	func	pointer to a law function defined by subdomain

◆ cs_property_def_by_scavec_law()

void cs_property_def_by_scavec_law	(	cs_property_t *	pty,
		const char *	ml_name,
		const void *	context,
		cs_scavec_law_func_t *	func
	)

Define a cs_property_t structure by a law (using as arguments a scalar and a vector) for entities attached to the mesh location named ml_name.

Parameters

[in,out]	pty	pointer to a cs_property_t structure
[in]	ml_name	name of the related mesh location
[in]	context	pointer to a structure (may be NULL)
[in]	func	pointer to a law function defined by subdomain

Define a cs_property_t structure by a law (using as arguments a scalar and a vector) for entities attached to the mesh location named ml_name.

Parameters

[in,out]	pty	pointer to a cs_property_t structure
[in]	ml_name	name of the related mesh location
[in]	context	pointer to a structure (may be NULL)
[in]	func	pointer to a law function defined by subdomain

◆ cs_property_def_by_twovar_law()

void cs_property_def_by_twovar_law	(	cs_property_t *	pty,
		const char *	ml_name,
		const void *	context,
		cs_twovar_law_func_t *	func
	)

Define a cs_property_t structure thanks to a law depending on two scalars variables in a subdomain attached to the mesh location named ml_name.

Parameters

[in,out]	pty	pointer to a cs_property_t structure
[in]	ml_name	name of the related mesh location
[in]	context	pointer to a structure (may be NULL)
[in]	func	pointer to a function

◆ cs_property_def_by_value()

void cs_property_def_by_value	(	cs_property_t *	pty,
		const char *	ml_name,
		const char *	key_val
	)

Define a cs_property_t structure by value for entities attached to the mesh location named ml_name.

Parameters

[in,out]	pty	pointer to a cs_property_t structure
[in]	ml_name	name of the related mesh location
[in]	keyval	accessor to the value to set

◆ cs_property_free()

cs_property_t* cs_property_free ( cs_property_t * pty )

Free a cs_property_t structure.

Parameters

[in,out] pty pointer to a cs_property_t structure to free

Returns: a NULL pointer

◆ cs_property_get_cell_tensor()

void cs_property_get_cell_tensor	(	cs_lnum_t	c_id,
		const cs_property_t *	pty,
		bool	do_inversion,
		cs_real_3_t *	tensor
	)

Compute the value of the tensor attached a property at the cell center.

Parameters

[in]	c_id	id of the current cell
[in]	pty	pointer to a cs_property_t structure
[in]	do_inversion	true or false
[in,out]	tensor	3x3 matrix

◆ cs_property_get_cell_value()

cs_real_t cs_property_get_cell_value	(	cs_lnum_t	c_id,
		const cs_property_t *	pty
	)

Compute the value of a property at the cell center.

Parameters

[in]	c_id	id of the current cell
[in]	pty	pointer to a cs_property_t structure

Returns: the value of the property for the given cell

◆ cs_property_get_fourier()

void cs_property_get_fourier	(	const cs_property_t *	pty,
		double	dt,
		cs_real_t	fourier[]
	)

Compute the Fourier number in each cell.

Parameters

[in]	pty	pointer to the diffusive property struct.
[in]	dt	value of the current time step
[in,out]	fourier	pointer to an array storing Fourier numbers

◆ cs_property_get_name()

const char* cs_property_get_name ( const cs_property_t * pty )

Retrieve the name of a property.

Parameters

[in] pty pointer to a property

Returns: the name of the related property

◆ cs_property_get_type()

cs_property_type_t cs_property_get_type ( const cs_property_t * pty )

Retrieve the type of a property.

Parameters

[in] pty pointer to a property

Returns: the type of the related property

◆ cs_property_is_uniform()

bool cs_property_is_uniform ( const cs_property_t * pty )

returns true if the property is uniform, otherwise false

Parameters

[in] pty pointer to a property to test

Returns: true or false

◆ cs_property_iso_def_by_value()

void cs_property_iso_def_by_value	(	cs_property_t *	pty,
		const char *	ml_name,
		double	val
	)

Define an isotropic cs_property_t structure by value for entities attached to the mesh location named ml_name.

Parameters

[in,out]	pty	pointer to a cs_property_t structure
[in]	ml_name	name of the related mesh location
[in]	val	value to set

◆ cs_property_ortho_def_by_value()

void cs_property_ortho_def_by_value	(	cs_property_t *	pty,
		const char *	ml_name,
		const double	val[]
	)

Define orthotropic cs_property_t structure by value for entities attached to the mesh location named ml_name.

Parameters

[in,out]	pty	pointer to a cs_property_t structure
[in]	ml_name	name of the related mesh location
[in]	val	values to set (vector of size 3)

◆ cs_property_set_array()

void cs_property_set_array	(	cs_property_t *	pty,
		cs_desc_t	desc,
		cs_real_t *	array
	)

Set the "array" member of a cs_property_t structure.

Parameters

[in,out]	pty	pointer to a cs_property_t structure
[in]	desc	information about this array
[in]	array	pointer to an array of values

◆ cs_property_set_second_array()

void cs_property_set_second_array	(	cs_property_t *	pty,
		cs_desc_t	desc,
		cs_real_t *	array
	)

Set the second "array" member of a cs_property_t structure.

Parameters

[in,out]	pty	pointer to a cs_property_t structure
[in]	desc	information about this array
[in]	array	pointer to an array of values

◆ cs_property_set_shared_pointers()

void cs_property_set_shared_pointers	(	const cs_cdo_quantities_t *	quant,
		const cs_cdo_connect_t *	connect,
		const cs_time_step_t *	time_step
	)

Set shared pointers to main domain members.

Parameters

[in]	quant	additional mesh quantities struct.
[in]	connect	pointer to a cs_cdo_connect_t struct.
[in]	time_step	pointer to a time step structure

◆ cs_property_set_timer_stats()

void cs_property_set_timer_stats ( int level )

Initialize cs_timer_stats_t structure for monitoring purpose.

Parameters

[in] level level of details requested

◆ cs_property_summary()

void cs_property_summary ( const cs_property_t * pty )

Print a summary of a cs_property_t structure.

Parameters

[in] pty pointer to a cs_property_t structure to summarize

Enumerations

Functions

Enumeration Type Documentation

◆ cs_property_type_t

Function Documentation

◆ cs_property_aniso_def_by_value()

◆ cs_property_check_name()

◆ cs_property_create()

◆ cs_property_def_by_analytic()

◆ cs_property_def_by_array()

◆ cs_property_def_by_law()

◆ cs_property_def_by_scavec_law()

◆ cs_property_def_by_twovar_law()

◆ cs_property_def_by_value()

◆ cs_property_free()

◆ cs_property_get_cell_tensor()

◆ cs_property_get_cell_value()

◆ cs_property_get_fourier()

◆ cs_property_get_name()

◆ cs_property_get_type()

◆ cs_property_is_uniform()

◆ cs_property_iso_def_by_value()

◆ cs_property_ortho_def_by_value()

◆ cs_property_set_array()

◆ cs_property_set_second_array()

◆ cs_property_set_shared_pointers()

◆ cs_property_set_timer_stats()

◆ cs_property_summary()