#include "cs_defs.h"

Include dependency graph for cs_medcoupling_postprocess.h:

Functions
cs_medcoupling_slice_t *	cs_medcoupling_slice_by_id (int id)
	Get pointer to a slice based on id. More...

cs_medcoupling_slice_t *	cs_medcoupling_slice_by_name (const char *name)
	Get pointer to slice based on name, raises an error if not found. More...

cs_medcoupling_slice_t *	cs_medcoupling_slice_by_name_try (const char *name)
	Get pointer to slice based on name. Returns nullptr if not found. More...

void	cs_medcoupling_postprocess_add_plane_slice (const char name, const char selection_criteria, const cs_real_t origin[], const cs_real_t normal[], const cs_real_t length1, const cs_real_t length2)
	Add a slice based on a plane. More...

void	cs_medcoupling_postprocess_add_disc_slice (const char name, const char selection_criteria, const cs_real_t origin[], const cs_real_t normal[], const cs_real_t radius, const int n_sectors)
	Add a slice based on a disc. More...

void	cs_medcoupling_postprocess_add_annulus_slice (const char name, const char selection_criteria, const cs_real_t origin[], const cs_real_t normal[], const cs_real_t radius1, const cs_real_t radius2, const int n_sectors)
	Add a slice based on an annulus. More...

cs_lnum_t	cs_medcoupling_slice_get_n_elts (const char *name)
	Get number cells that may be intersected by the slice. More...

cs_lnum_t *	cs_medcoupling_slice_get_elt_ids (const char *name)
	Get list of ids of the elements which may be intersected. More...

cs_real_t *	cs_medcoupling_slice_get_surfaces (const char *name)
	Get list of intersection surfaces for each cell intersected. More...

cs_real_t	cs_medcoupling_slice_get_total_surface (const char *name)
	Get total intersection surface between a slice and volume mesh. More...

void	cs_medcoupling_slice_activate_postprocess (const char *name)
	Activate postprocessing of intersected cells. More...

cs_real_t	cs_medcoupling_slice_scalar_integral (const char name, const cs_real_t scalar)
	Compute integral of a scalar over a slice. More...

cs_real_t	cs_medcoupling_slice_scalar_mean (const char name, const cs_real_t scalar)
	Compute mean value of a scalar over a slice. More...

cs_real_t	cs_medcoupling_slice_scalar_integral_weighted (const char name, const cs_real_t scalar, const cs_real_t weight_s, const cs_real_3_t weight_v)
	Compute integral of a scalar over a slice using a scalar and/or vectorial weights. If nullptr is provided for both weights, the non-weighted function is called. More...

cs_real_t	cs_medcoupling_slice_scalar_mean_weighted (const char name, const cs_real_t scalar, const cs_real_t weight_s, const cs_real_3_t weight_v)
	Compute mean of a scalar over a slice using a scalar and/or vectorial weights. If nullptr is provided for both weights, the non-weighted function is called. More...

void	cs_medcoupling_slice_destroy_all (void)
	Destroy all slices. More...

Function Documentation

◆ cs_medcoupling_postprocess_add_annulus_slice()

void cs_medcoupling_postprocess_add_annulus_slice	(	const char *	name,
		const char *	selection_criteria,
		const cs_real_t	origin[],
		const cs_real_t	normal[],
		const cs_real_t	radius1,
		const cs_real_t	radius2,
		const int	n_sectors
	)

Add a slice based on an annulus.

Parameters

[in]	name	name of the slice
[in]	selection_criteria	selection criteria for cells
[in]	origin	coordinates of slice's origin point
[in]	normal	normal vector of the slice
[in]	radius1	inner disc's radius
[in]	radius2	outer disc's radius
[in]	n_sectors	number of sectors for discretization. if negative, default value (36) is used.

◆ cs_medcoupling_postprocess_add_disc_slice()

void cs_medcoupling_postprocess_add_disc_slice	(	const char *	name,
		const char *	selection_criteria,
		const cs_real_t	origin[],
		const cs_real_t	normal[],
		const cs_real_t	radius,
		const int	n_sectors
	)

Add a slice based on a disc.

Parameters

[in]	name	Name of the slice
[in]	selection_criteria	Selection criteria for cells to intersect
[in]	origin	Coordinates of origin point of slice
[in]	normal	Normal vector of the slice
[in]	radius	Radius of the disc
[in]	n_sectors	Number of sectors for discretization. If negative default value (36) is used.

Parameters

[in]	name	name of the slice
[in]	selection_criteria	selection criteria for cells
[in]	origin	coordinates of slice's origin point
[in]	normal	normal vector of the slice
[in]	radius	disc's radius
[in]	n_sectors	number of sectors for discretization. if negative, default value (36) is used.

◆ cs_medcoupling_postprocess_add_plane_slice()

void cs_medcoupling_postprocess_add_plane_slice	(	const char *	name,
		const char *	selection_criteria,
		const cs_real_t	origin[],
		const cs_real_t	normal[],
		const cs_real_t	length1,
		const cs_real_t	length2
	)

Add a slice based on a plane.

Parameters

[in]	name	name of the slice
[in]	selection_criteria	selection criteria for cells
[in]	origin	coordinates of slice's origin point
[in]	normal	normal vector of the slice
[in]	length1	length along the plane's first axis
[in]	length2	length along the plane's second axis

◆ cs_medcoupling_slice_activate_postprocess()

void cs_medcoupling_slice_activate_postprocess ( const char * name )

Activate postprocessing of intersected cells.

Parameters

[in] name Name of the slice

◆ cs_medcoupling_slice_by_id()

cs_medcoupling_slice_t * cs_medcoupling_slice_by_id ( int id )

Get pointer to a slice based on id.

Returns: pointer to slice. Raises an error if index is out of bounds.

Parameters

[in] id index of the slice

◆ cs_medcoupling_slice_by_name()

cs_medcoupling_slice_t * cs_medcoupling_slice_by_name ( const char * name )

Get pointer to slice based on name, raises an error if not found.

Returns: pointer to slice, raises error if not found.

Parameters

[in] name name of the slice

◆ cs_medcoupling_slice_by_name_try()

cs_medcoupling_slice_t * cs_medcoupling_slice_by_name_try ( const char * name )

Get pointer to slice based on name. Returns nullptr if not found.

Returns: pointer to slice, nullptr if not found.

Parameters

[in] name name of the slice

◆ cs_medcoupling_slice_destroy_all()

void cs_medcoupling_slice_destroy_all ( void )

Destroy all slices.

◆ cs_medcoupling_slice_get_elt_ids()

cs_lnum_t * cs_medcoupling_slice_get_elt_ids ( const char * name )

Get list of ids of the elements which may be intersected.

Returns: Pointer to list of ids (cs_lnum_t *). Do not deallocate!

Parameters

[in] name name of the slice

◆ cs_medcoupling_slice_get_n_elts()

cs_lnum_t cs_medcoupling_slice_get_n_elts ( const char * name )

Get number cells that may be intersected by the slice.

Returns: Number of elements

Parameters

[in] name name of the slice

◆ cs_medcoupling_slice_get_surfaces()

cs_real_t * cs_medcoupling_slice_get_surfaces ( const char * name )

Get list of intersection surfaces for each cell intersected.

Returns: Pointer to list of intersection surfaces (cs_real_t *)

Parameters

[in] name name of the slice

◆ cs_medcoupling_slice_get_total_surface()

cs_real_t cs_medcoupling_slice_get_total_surface ( const char * name )

Get total intersection surface between a slice and volume mesh.

Returns: Value of total intersection surface

Parameters

[in] name name of the slice

◆ cs_medcoupling_slice_scalar_integral()

cs_real_t cs_medcoupling_slice_scalar_integral	(	const char *	name,
		const cs_real_t *	scalar
	)

Compute integral of a scalar over a slice.

Returns: Global integrated value. A cs_parall_sum is used.

Parameters

[in]	name	name of the slice
[in]	scalar	array of scalar values (size n_cells)

◆ cs_medcoupling_slice_scalar_integral_weighted()

cs_real_t cs_medcoupling_slice_scalar_integral_weighted	(	const char *	name,
		const cs_real_t *	scalar,
		const cs_real_t *	weight_s,
		const cs_real_3_t *	weight_v
	)

Compute integral of a scalar over a slice using a scalar and/or vectorial weights. If nullptr is provided for both weights, the non-weighted function is called.

Returns: Computed integral value over entire slice (parallel)

Parameters

[in]	name	name of the slice
[in]	scalar	array of scalar values (size n_cells)
[in]	weight_s	scalar weight array (n_cells)
[in]	weight_v	vectorial weight array (n_cells)

◆ cs_medcoupling_slice_scalar_mean()

cs_real_t cs_medcoupling_slice_scalar_mean	(	const char *	name,
		const cs_real_t *	scalar
	)

Compute mean value of a scalar over a slice.

Returns: Global integrated value. A cs_parall_sum is used.

Parameters

[in]	name	name of the slice
[in]	scalar	array of scalar values (size n_cells)

◆ cs_medcoupling_slice_scalar_mean_weighted()

cs_real_t cs_medcoupling_slice_scalar_mean_weighted	(	const char *	name,
		const cs_real_t *	scalar,
		const cs_real_t *	weight_s,
		const cs_real_3_t *	weight_v
	)

Compute mean of a scalar over a slice using a scalar and/or vectorial weights. If nullptr is provided for both weights, the non-weighted function is called.

Returns: Computed mean value over entire slice (parallel)

Parameters

[in]	name	name of the slice
[in]	scalar	array of scalar values (size n_cells)
[in]	weight_s	scalar weight array (n_cells)
[in]	weight_v	vectorial weight array (n_cells)

Functions

Function Documentation

◆ cs_medcoupling_postprocess_add_annulus_slice()

◆ cs_medcoupling_postprocess_add_disc_slice()

◆ cs_medcoupling_postprocess_add_plane_slice()

◆ cs_medcoupling_slice_activate_postprocess()

◆ cs_medcoupling_slice_by_id()

◆ cs_medcoupling_slice_by_name()

◆ cs_medcoupling_slice_by_name_try()

◆ cs_medcoupling_slice_destroy_all()

◆ cs_medcoupling_slice_get_elt_ids()

◆ cs_medcoupling_slice_get_n_elts()

◆ cs_medcoupling_slice_get_surfaces()

◆ cs_medcoupling_slice_get_total_surface()

◆ cs_medcoupling_slice_scalar_integral()

◆ cs_medcoupling_slice_scalar_integral_weighted()

◆ cs_medcoupling_slice_scalar_mean()

◆ cs_medcoupling_slice_scalar_mean_weighted()