cs_post_util.cpp File Reference

#include "base/cs_defs.h"
#include <assert.h>
#include <math.h>
#include <string.h>
#include "bft/bft_printf.h"
#include "base/cs_array_reduce.h"
#include "alge/cs_balance_by_zone.h"
#include "base/cs_base.h"
#include "base/cs_field.h"
#include "base/cs_field_pointer.h"
#include "base/cs_field_operator.h"
#include "mesh/cs_geom.h"
#include "base/cs_math.h"
#include "base/cs_mem.h"
#include "mesh/cs_mesh.h"
#include "mesh/cs_mesh_intersect.h"
#include "mesh/cs_mesh_location.h"
#include "mesh/cs_mesh_quantities.h"
#include "base/cs_parall.h"
#include "pprt/cs_physical_model.h"
#include "base/cs_physical_constants.h"
#include "base/cs_prototypes.h"
#include "base/cs_selector.h"
#include "base/cs_turbomachinery.h"
#include "turb/cs_turbulence_model.h"
#include "base/cs_velocity_pressure.h"
#include "base/cs_post_util.h"

Include dependency graph for cs_post_util.cpp:

Functions
void	cs_cell_segment_intersect_select (void *input, cs_lnum_t *n_cells, cs_lnum_t **cell_ids)
	Select cells cut by a given segment.
void	cs_cell_polyline_intersect_select (void *input, cs_lnum_t n_points, cs_lnum_t *n_cells, cs_lnum_t **cell_ids, cs_real_t **seg_c_len, cs_real_3_t **seg_c_cen)
	Select cells cut by a line composed of segments.
void	cs_cell_segment_intersect_probes_define (void *input, cs_lnum_t *n_elts, cs_real_3_t **coords, cs_real_t **s)
	Define probes based on the centers of cells intersected by a given segment.
void	cs_b_face_criterion_probes_define (void *input, cs_lnum_t *n_elts, cs_real_3_t **coords, cs_real_t **s)
	Define a profile based on centers of faces defined by a given criterion.
cs_real_t	cs_post_turbomachinery_head (const char *criteria_in, cs_mesh_location_type_t location_in, const char *criteria_out, cs_mesh_location_type_t location_out)
	Compute the head of a turbomachinery (total pressure increase)
cs_real_t	cs_post_moment_of_force (cs_lnum_t n_b_faces, const cs_lnum_t b_face_ids[], cs_real_t axis[3])
	Compute the magnitude of a moment of force torque) given an axis and the stress on a specific boundary.
void	cs_post_stress_tangential (cs_lnum_t n_b_faces, const cs_lnum_t b_face_ids[], cs_real_3_t stress[])
	Compute tangential stress on a specific boundary.
void	cs_post_b_pressure (cs_lnum_t n_b_faces, const cs_lnum_t b_face_ids[], cs_real_t pres[])
	Compute pressure on a specific boundary region.
void	cs_post_b_total_pressure (cs_lnum_t n_b_faces, const cs_lnum_t b_face_ids[], cs_real_t pres[])
	Compute total pressure on a specific boundary region.
void	cs_post_evm_reynolds_stresses (cs_field_interpolate_t interpolation_type, cs_lnum_t n_cells, const cs_lnum_t cell_ids[], const cs_real_3_t *coords, cs_real_6_t *rst)
	Compute Reynolds stresses in case of Eddy Viscosity Models.
void	cs_post_anisotropy_invariant (cs_lnum_t n_cells, const cs_lnum_t cell_ids[], const cs_real_t coords[][3], cs_real_2_t inv[])
	Compute the invariant of the anisotropy tensor.
void	cs_post_boundary_flux (const char *scalar_name, cs_lnum_t n_loc_b_faces, const cs_lnum_t b_face_ids[], cs_real_t b_face_flux[])
	Compute scalar flux on a specific boundary region.
void	cs_post_field_cell_to_b_face_values (const cs_field_t *f, cs_lnum_t n_loc_b_faces, const cs_lnum_t b_face_ids[], cs_real_t *b_val)
	Compute values at a selection of boundary faces of a given field located on cells.
cs_real_t	cs_post_scalar_boundary_integral (const cs_real_t *scalar_vals, const cs_lnum_t n_loc_b_faces, const cs_lnum_t b_face_ids[])
	Compute the surface integral of a scalar array of values located on boundary faces over a selection of boundary faces.
cs_real_t	cs_post_bnd_scalar_boundary_integral (const cs_real_t *scalar_vals, const cs_lnum_t n_loc_b_faces, const cs_lnum_t b_face_ids[])
	Compute the surface integral over a selection of boundary faces for a scalar array of values located over the selection.
cs_real_t	cs_post_scalar_boundary_mean (const cs_real_t *scalar_vals, const cs_lnum_t n_loc_b_faces, const cs_lnum_t b_face_ids[])
	Compute the surface mean of a scalar array of values located on boundary faces over a selection of boundary faces. Weighting is done using total surface of boundary faces.
cs_real_t	cs_post_bnd_scalar_boundary_mean (const cs_real_t *scalar_vals, const cs_lnum_t n_loc_b_faces, const cs_lnum_t b_face_ids[])
	Compute the surface mean over a selection of boundary faces for a scalar array of values located over the selection. Weighting is done using total surface of boundary faces.
cs_real_t	cs_post_scalar_b_zone_integral (const cs_zone_t *z, const cs_real_t *scalar_vals)
	Compute the surface integral of a scalar array of values located on boundary faces over a boundary zone.
cs_real_t	cs_post_bnd_scalar_b_zone_integral (const cs_zone_t *z, const cs_real_t *scalar_vals)
	Compute the surface integral of a scalar over a boundary zone faces, for an array of values located on the zone's faces.
cs_real_t	cs_post_scalar_b_zone_mean (const cs_zone_t *z, const cs_real_t *scalar_vals)
	Compute the surface mean of a scalar array of values located on boundary faces over a boundary zone. Weighting is done using total surface of boundary faces.
cs_real_t	cs_post_bnd_scalar_b_zone_mean (const cs_zone_t *z, const cs_real_t *scalar_vals)
	Compute the surface mean of a scalar over a boundary zone faces, for an array of values located on the zone's faces. Weighting is done using total surface of boundary faces.

Function Documentation

cs_b_face_criterion_probes_define()

void cs_b_face_criterion_probes_define	(	void *	input,
		cs_lnum_t *	n_elts,
		cs_real_3_t **	coords,
		cs_real_t **	s )

Define a profile based on centers of faces defined by a given criterion.

Here, the input points to string describing a selection criterion.

Parameters

[in]	input	pointer to selection criterion
[out]	n_elts	number of selected coordinates
[out]	coords	coordinates of selected elements.
[out]	s	curvilinear coordinates of selected elements

cs_cell_polyline_intersect_select()

void cs_cell_polyline_intersect_select	(	void *	input,
		cs_lnum_t	n_points,
		cs_lnum_t *	n_cells,
		cs_lnum_t **	cell_ids,
		cs_real_t **	seg_c_len,
		cs_real_3_t **	seg_c_cen )

Select cells cut by a line composed of segments.

This selection function may be used as an elements selection function for postprocessing.

In this case, the input points to a real array containing the segment's start and end coordinates.

Note: the input pointer must point to valid data when this selection function is called, so either:

• that value or structure should not be temporary (i.e. local);
• post-processing output must be ensured using cs_post_write_meshes() with a fixed-mesh writer before the data pointed to goes out of scope;

The caller is responsible for freeing the returned cell_ids array. When passed to postprocessing mesh or probe set definition functions, this is handled automatically.

Deprecated

Use cs_mesh_intersect_polyline_cell_select (rename) instead.

Parameters

[in]	input	pointer to segments starts and ends: [x0, y0, z0, x1, y1, z1]
[in]	n_points	number of vertices in the polyline
[out]	n_cells	number of selected cells
[out]	cell_ids	array of selected cell ids (0 to n-1 numbering)
[out]	seg_c_len	array of length of the segment in the selected cells
[out]	seg_c_cen	array of center coordinates of the segment in the selected cells

cs_cell_segment_intersect_probes_define()

void cs_cell_segment_intersect_probes_define	(	void *	input,
		cs_lnum_t *	n_elts,
		cs_real_3_t **	coords,
		cs_real_t **	s )

Define probes based on the centers of cells intersected by a given segment.

This selection function may be used as a probe set definition function for postprocessing.

In this case, the input points to a real array containing the segment's start and end coordinates.

Note: the input pointer must point to valid data when this selection function is called, so either:

• that value or structure should not be temporary (i.e. local);
• post-processing output must be ensured using cs_post_write_meshes() with a fixed-mesh writer before the data pointed to goes out of scope;

The caller is responsible for freeing the returned cell_ids array. When passed to postprocessing mesh or probe set definition functions, this is handled automatically.

Deprecated

: higher-level cs_probe_set_create_from_segment function with n_probes argument set at 0 or lower includes equivalent function.

Parameters

[in]	input	pointer to segment start and end: [x0, y0, z0, x1, y1, z1]
[out]	n_elts	number of selected coordinates
[out]	coords	coordinates of selected elements.
[out]	s	curvilinear coordinates of selected elements

cs_cell_segment_intersect_select()

void cs_cell_segment_intersect_select	(	void *	input,
		cs_lnum_t *	n_cells,
		cs_lnum_t **	cell_ids )

Select cells cut by a given segment.

This selection function may be used as an elements selection function for postprocessing.

In this case, the input points to a real array containing the segment's start and end coordinates.

Note: the input pointer must point to valid data when this selection function is called, so either:

• that value or structure should not be temporary (i.e. local);
• post-processing output must be ensured using cs_post_write_meshes() with a fixed-mesh writer before the data pointed to goes out of scope;

The caller is responsible for freeing the returned cell_ids array. When passed to postprocessing mesh or probe set definition functions, this is handled automatically.

Deprecated

Use cs_mesh_intersect_segment_cell_select (rename) instead.

Parameters

[in]	input	pointer to segment start and end: [x0, y0, z0, x1, y1, z1]
[out]	n_cells	number of selected cells
[out]	cell_ids	array of selected cell ids (0 to n-1 numbering)

cs_post_anisotropy_invariant()

void cs_post_anisotropy_invariant	(	cs_lnum_t	n_cells,
		const cs_lnum_t	cell_ids[],
		const cs_real_t	coords[][3],
		cs_real_2_t	inv[] )

Compute the invariant of the anisotropy tensor.

Parameters

[in]	n_cells	number of points
[in]	cell_ids	cell location of points (indexed from 0 to n-1)
[in]	coords	point coordinates
[out]	inv	Anisotropy tensor invariant [xsi, eta]

cs_post_b_pressure()

void cs_post_b_pressure	(	cs_lnum_t	n_b_faces,
		const cs_lnum_t	b_face_ids[],
		cs_real_t	pres[] )

Compute pressure on a specific boundary region.

Parameters

[in]	n_b_faces	number of faces
[in]	b_face_ids	list of faces (0 to n-1)
[out]	pres	pressure on a specific boundary region

cs_post_b_total_pressure()

void cs_post_b_total_pressure	(	cs_lnum_t	n_b_faces,
		const cs_lnum_t	b_face_ids[],
		cs_real_t	pres[] )

Compute total pressure on a specific boundary region.

Parameters

[in]	n_b_faces	number of faces
[in]	b_face_ids	list of faces (0 to n-1)
[out]	pres	total pressure on a specific boundary region

cs_post_bnd_scalar_b_zone_integral()

cs_real_t cs_post_bnd_scalar_b_zone_integral	(	const cs_zone_t *	z,
		const cs_real_t *	scalar_vals )

Compute the surface integral of a scalar over a boundary zone faces, for an array of values located on the zone's faces.

Parameters

[in]	z	pointer to boundary zone
[in]	scalar_vals	array of scalar values of size n_b_faces

Returns

Value of computed surface integral

cs_post_bnd_scalar_b_zone_mean()

cs_real_t cs_post_bnd_scalar_b_zone_mean	(	const cs_zone_t *	z,
		const cs_real_t *	scalar_vals )

Compute the surface mean of a scalar over a boundary zone faces, for an array of values located on the zone's faces. Weighting is done using total surface of boundary faces.

Parameters

[in]	z	pointer to boundary zone
[in]	scalar_vals	array of scalar values of size n_b_faces

Returns

Value of computed surface mean value

cs_post_bnd_scalar_boundary_integral()

cs_real_t cs_post_bnd_scalar_boundary_integral	(	const cs_real_t *	scalar_vals,
		const cs_lnum_t	n_loc_b_faces,
		const cs_lnum_t	b_face_ids[] )

Compute the surface integral over a selection of boundary faces for a scalar array of values located over the selection.

Parameters

[in]	scalar_vals	array of scalar values of size n_b_faces
[in]	n_loc_b_faces	number of selected boundary faces
[in]	b_face_ids	ids of selected boundary faces

Returns

Value of computed surface integral

cs_post_bnd_scalar_boundary_mean()

cs_real_t cs_post_bnd_scalar_boundary_mean	(	const cs_real_t *	scalar_vals,
		const cs_lnum_t	n_loc_b_faces,
		const cs_lnum_t	b_face_ids[] )

Compute the surface mean over a selection of boundary faces for a scalar array of values located over the selection. Weighting is done using total surface of boundary faces.

Parameters

[in]	scalar_vals	array of scalar values of size n_b_faces
[in]	n_loc_b_faces	number of selected boundary faces
[in]	b_face_ids	ids of selected boundary faces

Returns

Value of computed surface mean value

cs_post_boundary_flux()

void cs_post_boundary_flux	(	const char *	scalar_name,
		cs_lnum_t	n_loc_b_faces,
		const cs_lnum_t	b_face_ids[],
		cs_real_t	b_face_flux[] )

Compute scalar flux on a specific boundary region.

The flux is counted negatively through the normal.

Parameters

[in]	scalar_name	scalar name
[in]	n_loc_b_faces	number of selected boundary faces
[in]	b_face_ids	ids of selected boundary faces
[out]	b_face_flux	surface flux through selected faces

cs_post_evm_reynolds_stresses()

void cs_post_evm_reynolds_stresses	(	cs_field_interpolate_t	interpolation_type,
		cs_lnum_t	n_cells,
		const cs_lnum_t	cell_ids[],
		const cs_real_3_t *	coords,
		cs_real_6_t *	rst )

Compute Reynolds stresses in case of Eddy Viscosity Models.

Parameters

[in]	interpolation_type	interpolation type for turbulent kinetic energy field
[in]	n_cells	number of points
[in]	cell_ids	cell location of points (indexed from 0 to n-1, or null if 1-to-1)
[in]	coords	point coordinates (or null for cell centers)
[out]	rst	Reynolds stresses stored as vector [r11, r22, r33, r12, r23, r13]

cs_post_field_cell_to_b_face_values()

void cs_post_field_cell_to_b_face_values	(	const cs_field_t *	f,
		cs_lnum_t	n_loc_b_faces,
		const cs_lnum_t	b_face_ids[],
		cs_real_t *	b_val )

Compute values at a selection of boundary faces of a given field located on cells.

Field BCs are taken into account and boundary cell values are reconstructed using the cell gradient.

Parameters

[in]	f	field pointer
[in]	n_loc_b_faces	number of selected boundary faces
[in]	b_face_ids	ids of selected boundary faces
[out]	b_val	values on boundary faces

cs_post_moment_of_force()

cs_real_t cs_post_moment_of_force	(	cs_lnum_t	n_b_faces,
		const cs_lnum_t	b_face_ids[],
		cs_real_t	axis[3] )

Compute the magnitude of a moment of force torque) given an axis and the stress on a specific boundary.

Parameters

[in]	n_b_faces	number of faces
[in]	b_face_ids	list of faces (0 to n-1)
[in]	axis	axis

Returns

couple about the axis

cs_post_scalar_b_zone_integral()

cs_real_t cs_post_scalar_b_zone_integral	(	const cs_zone_t *	z,
		const cs_real_t *	scalar_vals )

Compute the surface integral of a scalar array of values located on boundary faces over a boundary zone.

Parameters

[in]	z	pointer to boundary zone
[in]	scalar_vals	array of scalar values of size n_b_faces

Returns

Value of computed surface integral

cs_post_scalar_b_zone_mean()

cs_real_t cs_post_scalar_b_zone_mean	(	const cs_zone_t *	z,
		const cs_real_t *	scalar_vals )

Compute the surface mean of a scalar array of values located on boundary faces over a boundary zone. Weighting is done using total surface of boundary faces.

Parameters

[in]	z	pointer to boundary zone
[in]	scalar_vals	array of scalar values of size n_b_faces

Returns

Value of computed surface mean value

cs_post_scalar_boundary_integral()

cs_real_t cs_post_scalar_boundary_integral	(	const cs_real_t *	scalar_vals,
		const cs_lnum_t	n_loc_b_faces,
		const cs_lnum_t	b_face_ids[] )

Compute the surface integral of a scalar array of values located on boundary faces over a selection of boundary faces.

Parameters

[in]	scalar_vals	array of scalar values of size n_b_faces
[in]	n_loc_b_faces	number of selected boundary faces
[in]	b_face_ids	ids of selected boundary faces

Returns

Value of computed surface integral

cs_post_scalar_boundary_mean()

cs_real_t cs_post_scalar_boundary_mean	(	const cs_real_t *	scalar_vals,
		const cs_lnum_t	n_loc_b_faces,
		const cs_lnum_t	b_face_ids[] )

Compute the surface mean of a scalar array of values located on boundary faces over a selection of boundary faces. Weighting is done using total surface of boundary faces.

Parameters

[in]	scalar_vals	array of scalar values of size n_b_faces
[in]	n_loc_b_faces	number of selected boundary faces
[in]	b_face_ids	ids of selected boundary faces

Returns

Value of computed surface mean value

cs_post_stress_tangential()

void cs_post_stress_tangential	(	cs_lnum_t	n_b_faces,
		const cs_lnum_t	b_face_ids[],
		cs_real_3_t	stress[] )

Compute tangential stress on a specific boundary.

Parameters

[in]	n_b_faces	number of faces
[in]	b_face_ids	list of faces (0 to n-1)
[out]	stress	tangential stress on the specific boundary

cs_post_turbomachinery_head()

cs_real_t cs_post_turbomachinery_head	(	const char *	criteria_in,
		cs_mesh_location_type_t	location_in,
		const char *	criteria_out,
		cs_mesh_location_type_t	location_out )

Compute the head of a turbomachinery (total pressure increase)

Parameters

[in]	criteria_in	selection criteria of turbomachinery suction
[in]	location_in	mesh location of turbomachinery suction
[in]	criteria_out	selection criteria of turbomachinery discharge
[in]	location_out	mesh location of turbomachinery discharge

Returns

turbomachinery head