#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
cs_property_t *	cs_property_create (const char name, const char key_type, const cs_cdo_quantities_t cdoq, const cs_cdo_connect_t connect, const cs_time_step_t *time_step)
	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...

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

void	cs_property_set_value (cs_property_t *pty, const double val[])
	Set the value of a property attached to a cs_property_t structure. More...

void	cs_property_def_by_value (cs_property_t pty, const char val)
	Define the value of a cs_property_t structure. More...

void	cs_property_def_by_analytic (cs_property_t pty, cs_analytic_func_t func)
	Define a cs_property_t structure thanks to an analytic function. More...

void	cs_property_def_by_law (cs_property_t pty, cs_onevar_law_func_t func)
	Define a cs_property_t structure thanks to a law function. More...

void	cs_property_set_array (cs_property_t pty, cs_flag_t array_flag, const cs_real_t array)
	Set members of a cs_property_t structure. More...

void	cs_property_set_struct (cs_property_t pty, const void structure)
	Set "array" members of a cs_property_t structure. More...

void	cs_property_set_option (cs_property_t pty, const char keyname, const char *keyval)
	Set optional parameters related to 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...

Enumeration Type Documentation

enum cs_property_type_t

Enumerator
CS_PROPERTY_ISO
CS_PROPERTY_ORTHO
CS_PROPERTY_ANISO
CS_PROPERTY_N_TYPES

Function Documentation

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_t* cs_property_create	(	const char *	name,
		const char *	key_type,
		const cs_cdo_quantities_t *	cdoq,
		const cs_cdo_connect_t *	connect,
		const cs_time_step_t *	time_step
	)

Create and initialize a new property structure.

Parameters

[in]	name	name of the property
[in]	key_type	keyname of the type of property
[in]	cdoq	pointer to a cs_cdo_quantities_t struct.
[in]	connect	pointer to a cs_cdo_connect_t struct.
[in]	time_step	pointer to a cs_time_step_t struct.

Returns: a pointer to a new allocated cs_property_t structure

void cs_property_def_by_analytic	(	cs_property_t *	pty,
		cs_analytic_func_t *	func
	)

Define a cs_property_t structure thanks to an analytic function.

Parameters

[in,out]	pty	pointer to a cs_property_t structure
[in]	func	pointer to a function

void cs_property_def_by_law	(	cs_property_t *	pty,
		cs_onevar_law_func_t *	func
	)

Define a cs_property_t structure thanks to a law function.

Parameters

[in,out]	pty	pointer to a cs_property_t structure
[in]	func	pointer to a function

void cs_property_def_by_value	(	cs_property_t *	pty,
		const char *	val
	)

Define the value of a cs_property_t structure.

Parameters

[in,out]	pty	pointer to a cs_property_t structure
[in]	keyval	accessor to the value to set

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

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_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

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

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

void cs_property_set_array	(	cs_property_t *	pty,
		cs_flag_t	array_flag,
		const cs_real_t *	array
	)

Set members of a cs_property_t structure.

Parameters

[in,out]	pty	pointer to a cs_property_t structure
[in]	array_flag	information on the support of the array
[in]	array	pointer to an array of values

Set members of a cs_property_t structure.

Parameters

[in,out]	pty	pointer to a cs_property_t structure
[in]	array_flag	information on the support of the array
[in]	array	pointer to an array of values

void cs_property_set_option	(	cs_property_t *	pty,
		const char *	keyname,
		const char *	keyval
	)

Set optional parameters related to a cs_property_t structure.

Parameters

[in,out]	pty	pointer to a cs_property_t structure
[in]	keyname	name of key related to the member of pty to set
[in]	keyval	accessor to the value to set

void cs_property_set_struct	(	cs_property_t *	pty,
		const void *	structure
	)

Set "array" members of a cs_property_t structure.

Parameters

[in,out]	pty	pointer to a cs_property_t structure
[in]	structure	structure to associate to this property

void cs_property_set_value	(	cs_property_t *	pty,
		const double	val[]
	)

Set the value of a property attached to a cs_property_t structure.

Parameters

[in,out]	pty	pointer to a cs_property_t structure
[in]	val	pointer to an array of double

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

Function Documentation