#include "cs_base.h"

Include dependency graph for cs_probe.h:

Typedefs
typedef struct _cs_probe_set_t	cs_probe_set_t

Enumerations
enum	cs_probe_mode_t { CS_PROBE_MODE_EXACT, CS_PROBE_MODE_NEAREST_CELL_CENTER, CS_PROBE_MODE_NEAREST_VERTEX, CS_PROBE_N_MODES }

Functions
int	cs_probe_get_n_sets (void)
	Retrieve the number of probe sets defined. More...

cs_probe_set_t *	cs_probe_set_get (const char *name)
	Retrieve a cs_probe_set_t structure. More...

cs_probe_set_t *	cs_probe_set_get_by_id (int pset_id)
	Retrieve a cs_probe_set_t structure from its id. More...

const char *	cs_probe_set_get_name (cs_probe_set_t *pset)
	Retrieve the name related to a cs_probe_set_t structure. More...

void	cs_probe_set_get_post_info (const cs_probe_set_t pset, bool time_varying, bool is_profile, bool on_boundary, bool is_automatic, int n_writers, int *writer_ids[])
	Retrieve information useful for the postprocessing step. More...

bool	cs_probe_set_have_monitoring (void)
	Check if a set of monitoring probes has been defined among all the probe sets. More...

cs_probe_set_t *	cs_probe_set_create (const char *name)
	Create a new set of probes. More...

void	cs_probe_set_add_probe (cs_probe_set_t pset, const cs_real_t xyz, const char *label)
	Add a new probe to an existing set of probes. More...

cs_probe_set_t *	cs_probe_set_create_from_array (const char name, int n_probes, const cs_real_t coords, const char **labels)
	Define a new set of probes from an array of coordinates. More...

cs_probe_set_t *	cs_probe_set_create_from_segment (const char *name, int n_probes, const cs_real_t start_coords[3], const cs_real_t end_coords[3])
	Define a new set of probes from the segment spanned by two points. More...

void	cs_probe_set_associate_writers (cs_probe_set_t pset, int n_writers, const int writer_ids)
	Associate a list of writers to a probe set. More...

void	cs_probe_set_option (cs_probe_set_t pset, const char keyname, const char *keyval)
	Set optional parameters related to the management of a set of probes. More...

void	cs_probe_set_locate (cs_probe_set_t *pset)
	Try to locate each probe and define the coordinate really use for the postprocessing step. More...

fvm_nodal_t *	cs_probe_set_export_mesh (cs_probe_set_t pset, const char mesh_name)
	Define a fvm_nodal_t structure from the set of probes. More...

void	cs_probe_finalize (void)
	Free all structures related to a set of probes. More...

void	cs_probe_set_dump (const cs_probe_set_t *pset)
	Dump a cs_probe_set_t structure. More...

void	cs_probe_set_get_members (const cs_probe_set_t pset, int mode, int n_probes, cs_real_t coords[], cs_lnum_t ent_num[], float distances[])
	Retrieve the main members of a cs_probe_set_t structure. More...

Typedef Documentation

◆ cs_probe_set_t

typedef struct _cs_probe_set_t cs_probe_set_t

Enumeration Type Documentation

◆ cs_probe_mode_t

enum cs_probe_mode_t

Enumerator
CS_PROBE_MODE_EXACT
CS_PROBE_MODE_NEAREST_CELL_CENTER
CS_PROBE_MODE_NEAREST_VERTEX
CS_PROBE_N_MODES

Function Documentation

◆ cs_probe_finalize()

void cs_probe_finalize ( void )

Free all structures related to a set of probes.

◆ cs_probe_get_n_sets()

int cs_probe_get_n_sets ( void )

Retrieve the number of probe sets defined.

Returns: the number of probe sets defined

◆ cs_probe_set_add_probe()

void cs_probe_set_add_probe	(	cs_probe_set_t *	pset,
		const cs_real_t *	xyz,
		const char *	label
	)

Add a new probe to an existing set of probes.

Parameters

[in,out]	pset	set of probes
[in]	xyz	coordinates of the point to add
[in]	label	NULL or the name of the point (optional)

◆ cs_probe_set_associate_writers()

void cs_probe_set_associate_writers	(	cs_probe_set_t *	pset,
		int	n_writers,
		const int *	writer_ids
	)

Associate a list of writers to a probe set.

Parameters

[in,out]	pset	pointer to a cs_probe_set_t structure to set
[in]	n_writers	number of writers assocuated to this probe set
[in]	writer_ids	list of writer ids

◆ cs_probe_set_create()

cs_probe_set_t* cs_probe_set_create ( const char * name )

Create a new set of probes.

Parameters

[in] name name of the set of probes

Returns: a pointer to a new allocated cs_probe_set_t structure

◆ cs_probe_set_create_from_array()

cs_probe_set_t* cs_probe_set_create_from_array	(	const char *	name,
		int	n_probes,
		const cs_real_t *	coords,
		const char **	labels
	)

Define a new set of probes from an array of coordinates.

Parameters

[in]	name	name of the set of probes
[in]	n_probes	number of probes in coords and labels
[in]	coords	list of coordinates related to each probe
[in]	labels	list of label related to each probe (optional)

Returns: a pointer to a new allocated cs_probe_set_t structure

◆ cs_probe_set_create_from_segment()

cs_probe_set_t* cs_probe_set_create_from_segment	(	const char *	name,
		int	n_probes,
		const cs_real_t	start_coords[3],
		const cs_real_t	end_coords[3]
	)

Define a new set of probes from the segment spanned by two points.

Parameters

[in]	name	name of the set of probes
[in]	n_probes	number of probes
[in]	start_coords	coordinates of the starting point
[in]	end_coords	coordinates of the ending point

Returns: a pointer to a new allocated cs_probe_set_t structure

◆ cs_probe_set_dump()

void cs_probe_set_dump ( const cs_probe_set_t * pset )

Dump a cs_probe_set_t structure.

Parameters

[in] pset pointer to a cs_probe_set_t structure

◆ cs_probe_set_export_mesh()

fvm_nodal_t* cs_probe_set_export_mesh	(	cs_probe_set_t *	pset,
		const char *	mesh_name
	)

Define a fvm_nodal_t structure from the set of probes.

Parameters

[in,out]	pset	pointer to a cs_probe_set_t structure
[in]	mesh_name	name of the mesh to export

Returns: a pointer to a fvm_nodal_t structure

◆ cs_probe_set_get()

cs_probe_set_t* cs_probe_set_get ( const char * name )

Retrieve a cs_probe_set_t structure.

Parameters

[in] name name of the set of probes to find

Returns: a pointer to a cs_probes_t structure or NULL if not found

◆ cs_probe_set_get_by_id()

cs_probe_set_t* cs_probe_set_get_by_id ( int pset_id )

Retrieve a cs_probe_set_t structure from its id.

Parameters

[in] pset_id id related to the set of probes to find

Returns: a pointer to a cs_probes_t structure or NULL if not found

◆ cs_probe_set_get_members()

void cs_probe_set_get_members	(	const cs_probe_set_t *	pset,
		int *	mode,
		int *	n_probes,
		cs_real_t *	coords[],
		cs_lnum_t *	ent_num[],
		float *	distances[]
	)

Retrieve the main members of a cs_probe_set_t structure.

Parameters

[in]	pset	pointer to a cs_probe_set_t structure
[in,out]	mode	mode of location
[in,out]	n_probes	number of probes
[in,out]	coords	probe coordinates
[in,out]	ent_num	entity numbers (-1 if not located on this rank)
[in,out]	distances	distance of each probe from its related cell center

◆ cs_probe_set_get_name()

const char* cs_probe_set_get_name ( cs_probe_set_t * pset )

Retrieve the name related to a cs_probe_set_t structure.

Parameters

[in] pset pointer to a cs_probe_set_t structure

Returns: the name of the cs_probes_t structure or NULL if not found

◆ cs_probe_set_get_post_info()

void cs_probe_set_get_post_info	(	const cs_probe_set_t *	pset,
		bool *	time_varying,
		bool *	is_profile,
		bool *	on_boundary,
		bool *	is_automatic,
		int *	n_writers,
		int *	writer_ids[]
	)

Retrieve information useful for the postprocessing step.

Parameters

[in]	pset	pointer to a cs_probe_set_t structure
[out]	time_varying	true if probe coords may change during computation
[out]	is_profile	true if probe set is related to a profile
[out]	on_boundary	true if probes are located on boundary
[out]	is_automatic	true if the set of variables to post is predefined
[out]	n_writers	number of associated user-defined writers
[out]	writer_ids	list of writer ids
[in]	pset	pointer to a cs_probe_set_t structure
[out]	time_varying	true if probe coords may change during computation
[out]	is_profile	true if probe set is related to a profile
[out]	on_boundary	true if probes are located on boundary
[out]	is_automatic	true if set of variables to output is predefined
[out]	n_writers	number of associated user-defined writers
[out]	writer_ids	pointer to a list of writer ids

◆ cs_probe_set_have_monitoring()

bool cs_probe_set_have_monitoring ( void )

Check if a set of monitoring probes has been defined among all the probe sets.

Returns: true or false

◆ cs_probe_set_locate()

void cs_probe_set_locate ( cs_probe_set_t * pset )

Try to locate each probe and define the coordinate really use for the postprocessing step.

Parameters

[in,out] pset pointer to a cs_probe_set_t structure

◆ cs_probe_set_option()

void cs_probe_set_option	(	cs_probe_set_t *	pset,
		const char *	keyname,
		const char *	keyval
	)

Set optional parameters related to the management of a set of probes.

Parameters

[in,out]	pset	pointer to a cs_probe_set_t structure to set
[in]	keyname	name of the keyword related to the parameter to set
[in]	keyval	value of the keyword to set

Available option key names are the following:

activated where keyval is either true or false (default)
boundary where keyval is either true or false (default)
mode where keyval is exact, nearest_vertex or nearest_center (default)
profile where keyval is either true or false
selection_criteria where keyval is selection criteria string
tolerance where keyval is for instance "0.05" (default "0.10")
moving_probes where keyval is either true or false (default)

Parameters

[in,out]	pset	pointer to a cs_probe_set_t structure to set
[in]	keyname	name of the keyword related to the parameter to set
[in]	keyval	value of the keyword to set

Typedefs

Enumerations

Functions

Typedef Documentation

◆ cs_probe_set_t

Enumeration Type Documentation

◆ cs_probe_mode_t

Function Documentation

◆ cs_probe_finalize()

◆ cs_probe_get_n_sets()

◆ cs_probe_set_add_probe()

◆ cs_probe_set_associate_writers()

◆ cs_probe_set_create()

◆ cs_probe_set_create_from_array()

◆ cs_probe_set_create_from_segment()

◆ cs_probe_set_dump()

◆ cs_probe_set_export_mesh()

◆ cs_probe_set_get()

◆ cs_probe_set_get_by_id()

◆ cs_probe_set_get_members()

◆ cs_probe_set_get_name()

◆ cs_probe_set_get_post_info()

◆ cs_probe_set_have_monitoring()

◆ cs_probe_set_locate()

◆ cs_probe_set_option()