cs_paramedmem_remapper.h File Reference

#include "cs_defs.h"

Include dependency graph for cs_paramedmem_remapper.h:

Go to the source code of this file.

Functions
cs_paramedmem_remapper_t *	cs_paramedmem_remapper_create (char *name, const char *sel_criteria, char *file_name, char *mesh_name, cs_real_t center[3], cs_real_t radius)
	Creates a new cs_paramedmem_remapper_t instance. More...
cs_paramedmem_remapper_t *	cs_paramedmem_remapper_by_name_try (const char *name)
	get a remapper by its name More...
cs_real_t *	cs_paramedmem_remap_field (cs_paramedmem_remapper_t *r, char *field_name, cs_real_t default_val, int time_choice, double tval)
	Interpolate a given field on the local mesh for a given time. More...
cs_real_t *	cs_paramedmem_remap_field_one_time (cs_paramedmem_remapper_t *r, char *field_name, cs_real_t default_val, int dt, int it)
	Remaps a field from the med file to the local mesh for a given time. More...
void	cs_paramedmem_remapper_translate (cs_paramedmem_remapper_t *r, cs_real_t translation[3])
	translate the mesh using a given vector More...
void	cs_paramedmem_remapper_rotate (cs_paramedmem_remapper_t *r, cs_real_t invariant[3], cs_real_t axis[3], cs_real_t angle)
	Rotate the mesh using a center point, axis and angle. More...
void	cs_paramedmem_remapper_destroy_all (void)
	Destroy all remappers. More...

Function Documentation

cs_paramedmem_remap_field()

cs_real_t* cs_paramedmem_remap_field	(	cs_paramedmem_remapper_t *	r,
		char *	field_name,
		cs_real_t	default_val,
		int	time_choice,
		double	tval
	)

Interpolate a given field on the local mesh for a given time.

Parameters

[in]	r	pointer to cs_paramedmem_remapper_t struct
[in]	field_name	name of the field to remap from the file
[in]	default_val	default value for unmapped elements
[in]	time_choice	Choice of the time interpolation. 0: Value of field interpolated at t=tval from the med file. 1: Returns field values for the first time step in the file. tval is then ignored. 2: Returns field values for the last time step in the file. tval is then ignored.
[in]	tval	requested time instant. If time choice is 0 and tval outside of the file time bounds, return value will be at the the first time step (if tval < tmin) or last time step (if tval > tmax)

Returns

cs_real_t pointer containing the new values on target mesh

cs_paramedmem_remap_field_one_time()

cs_real_t* cs_paramedmem_remap_field_one_time	(	cs_paramedmem_remapper_t *	r,
		char *	field_name,
		cs_real_t	default_val,
		int	dt,
		int	it
	)

Remaps a field from the med file to the local mesh for a given time.

Parameters

[in]	r	pointer to cs_paramedmem_remapper_t struct
[in]	field_name	name of the field to remap from the file
[in]	default_val	default value for unmapped elements
[in]	dt	time value to use from the file
[in]	it	time iteration to use from the file

Returns

cs_real_t pointer containing the new values on target mesh

cs_paramedmem_remapper_by_name_try()

cs_paramedmem_remapper_t* cs_paramedmem_remapper_by_name_try

(

const char *

name

)

get a remapper by its name

Parameters

[in]

name

name of the remapper

Returns

pointer to cs_paramedmem_remapper_t struct

cs_paramedmem_remapper_create()

cs_paramedmem_remapper_t* cs_paramedmem_remapper_create	(	char *	name,
		const char *	sel_criteria,
		char *	file_name,
		char *	mesh_name,
		cs_real_t	center[3],
		cs_real_t	radius
	)

Creates a new cs_paramedmem_remapper_t instance.

Parameters

[in]	name	name of the remapper
[in]	sel_criteria	cells selection criteria
[in]	file_name	med file name
[in]	mesh_name	name of the mesh in the med file
[in]	center	center of bounding sphere
[in]	radius	radius of bounding sphere

Returns

cs_paramedmem_remapper_t struct

cs_paramedmem_remapper_destroy_all()

void cs_paramedmem_remapper_destroy_all

(

void

)

Destroy all remappers.

cs_paramedmem_remapper_rotate()

void cs_paramedmem_remapper_rotate	(	cs_paramedmem_remapper_t *	r,
		cs_real_t	invariant[3],
		cs_real_t	axis[3],
		cs_real_t	angle
	)

Rotate the mesh using a center point, axis and angle.

Parameters

[in]	r	pointer to the cs_paramedmem_remapper_t struct
[in]	invariant	coordinates of the invariant point
[in]	axis	rotation axis vector
[in]	angle	rotation angle in radians

cs_paramedmem_remapper_translate()

void cs_paramedmem_remapper_translate	(	cs_paramedmem_remapper_t *	r,
		cs_real_t	translation[3]
	)

translate the mesh using a given vector

Parameters

[in]	r	pointer to the cs_paramedmem_remapper_t struct
[in]	translation	translation vector