cs_meg_prototypes.h File Reference

#include "base/cs_base.h"
#include "base/cs_field.h"
#include "base/cs_volume_zone.h"
#include "base/cs_boundary_zone.h"
#include "base/cs_ibm.h"

Include dependency graph for cs_meg_prototypes.h:

Go to the source code of this file.

Typedefs
typedef void()	cs_ibm_volume_func_t(const cs_lnum_t c_id, const cs_real_3_t xyz, const cs_real_t t, cs_real_t *retval)
typedef void()	cs_ibm_fsi_func_t(cs_real_t *retval)

Functions
void	cs_meg_boundary_function (const char *zone_name, const cs_lnum_t n_elts, const cs_lnum_t *elt_ids, const cs_real_t xyz[][3], const char *field_name, const char *condition, cs_real_t *retvals)
	This function is used to compute user defined values for fields over a given boundary zone. The mathematical expression is defined in the GUI. More...
void	cs_meg_volume_function (const char *zone_name, const cs_lnum_t n_elts, const cs_lnum_t *elt_ids, const cs_real_t xyz[][3], const char *fields_names, cs_real_t *fvals[])
	This function is used to compute user defined values for fields over a given volume zone. The mathematical expression is defined in the GUI. More...
void	cs_meg_initialization (const char *zone_name, const cs_lnum_t n_elts, const cs_lnum_t *elt_ids, const cs_real_t xyz[][3], const char *field_name, cs_real_t *retvals)
	This function is used for the initalization of fields over a given volume zone. The mathematical expression is defined in the GUI. More...
void	cs_meg_source_terms (const char *zone_name, const cs_lnum_t n_elts, const cs_lnum_t *elt_ids, const cs_real_t xyz[][3], const char *name, const char *source_type, cs_real_t *retvals)
	This function is used to compute source terms over a volume zone. The mathematical expression is defined in the GUI. More...
void	cs_meg_fsi_struct (const char *object_type, const char *name, const cs_real_t fluid_f[], cs_real_t val[])
	This function is used to query FSI internal coupling structure values for a given boundary and structure. More...
void	cs_meg_post_activate (void)
	This function is used to activate postprocessing writers. More...
void	cs_meg_post_profiles (const char *name, int n_coords, cs_real_t coords[][3])
	This function is used to define profile coordinates. More...
void	cs_meg_post_calculator (const char *name, const cs_lnum_t n_elts, const cs_lnum_t *elt_ids, const cs_real_t xyz[][3], cs_real_t *retvals)
	This function is used to compute user defined calculator formulae. The mathematical expression is defined in the GUI. More...
cs_cutcell_func_t *	cs_meg_ibm_func_by_name (const char *object_name)
	This function is used to get the cs_cutcell_func_t pointer for a given object. More...
cs_ibm_volume_func_t *	cs_meg_ibm_volume_func_by_name (const char *object_name, const char *gui_var_name)
	This function is used to get the cs_ibm_volume_func_t pointer for a given object. More...
cs_ibm_fsi_func_t *	cs_meg_ibm_fsi_func_by_name (const char *object_name, const char *gui_var_name)
	This function is used to get the cs_ibm_fsi_func_t pointer for a given object. More...

Typedef Documentation

cs_ibm_fsi_func_t

typedef void() cs_ibm_fsi_func_t(cs_real_t *retval)

cs_ibm_volume_func_t

typedef void() cs_ibm_volume_func_t(const cs_lnum_t c_id, const cs_real_3_t xyz, const cs_real_t t, cs_real_t *retval)

Function Documentation

cs_meg_boundary_function()

void cs_meg_boundary_function	(	const char *	zone_name,
		const cs_lnum_t	n_elts,
		const cs_lnum_t *	elt_ids,
		const cs_real_t	xyz[][3],
		const char *	field_name,
		const char *	condition,
		cs_real_t *	retvals
	)

This function is used to compute user defined values for fields over a given boundary zone. The mathematical expression is defined in the GUI.

Parameters

[in]	zone_name	name of a boundary zone
[in]	n_elts	number of elements related to the zone
[in]	elt_ids	list of element ids related to the zone
[in]	xyz	list of coordinates related to the zone
[in]	field_name	name of the variable field
[in]	condition	condition type defined as a string
[out]	retvals	array of computed values

cs_meg_fsi_struct()

void cs_meg_fsi_struct	(	const char *	object_type,
		const char *	name,
		const cs_real_t	fluid_f[],
		cs_real_t	val[]
	)

This function is used to query FSI internal coupling structure values for a given boundary and structure.

Parameters

[in]	object_type	name of object type
[in]	name	name of matching boundary
[in]	fluid_f	array of fluid forces on the object
[in,out]	val[]	matrix or vector coefficients
[in]	object_type	name of object type
[in]	name	name of matching boundary
[in]	fluid_f	array of fluid forces on the object
[in,out]	val[]	matrix or vector coefficients

cs_meg_ibm_fsi_func_by_name()

cs_ibm_fsi_func_t * cs_meg_ibm_fsi_func_by_name	(	const char *	object_name,
		const char *	gui_var_name
	)

This function is used to get the cs_ibm_fsi_func_t pointer for a given object.

Returns

pointer to corresponding function.

This function is used to get the cs_ibm_fsi_func_t pointer for a given object.

Parameters

[in]	object_name	Name of the immersed object
[in]	var_name	Name of the variable

cs_meg_ibm_func_by_name()

cs_cutcell_func_t * cs_meg_ibm_func_by_name

(

const char *

object_name

)

This function is used to get the cs_cutcell_func_t pointer for a given object.

Returns

pointer to corresponding function.

Parameters

[in]

object_name

name of the object

cs_meg_ibm_volume_func_by_name()

cs_ibm_volume_func_t * cs_meg_ibm_volume_func_by_name	(	const char *	object_name,
		const char *	gui_var_name
	)

This function is used to get the cs_ibm_volume_func_t pointer for a given object.

Returns

pointer to corresponding function.

This function is used to get the cs_ibm_volume_func_t pointer for a given object.

Parameters

[in]	object_name	Name of the immersed object
[in]	var_name	Name of the variable

cs_meg_initialization()

void cs_meg_initialization	(	const char *	zone_name,
		const cs_lnum_t	n_elts,
		const cs_lnum_t *	elt_ids,
		const cs_real_t	xyz[][3],
		const char *	field_name,
		cs_real_t *	retvals
	)

This function is used for the initalization of fields over a given volume zone. The mathematical expression is defined in the GUI.

The caller is responsible for freeing the associated array.

Parameters

[in]	zone_name	name of a volume zone
[in]	n_elts	number of elements related to the zone
[in]	elt_ids	list of element ids related to the zone
[in]	xyz	list of coordinates related to the zone
[in]	field_name	associated variable field name
[out]	retvals	array of computed values

cs_meg_post_activate()

void cs_meg_post_activate

(

void

)

This function is used to activate postprocessing writers.

cs_meg_post_calculator()

void cs_meg_post_calculator	(	const char *	name,
		const cs_lnum_t	n_elts,
		const cs_lnum_t *	elt_ids,
		const cs_real_t	xyz[][3],
		cs_real_t *	retvals
	)

This function is used to compute user defined calculator formulae. The mathematical expression is defined in the GUI.

Parameters

[in]	field_name	function name
[in]	n_elts	number of elements related to the zone
[in]	elt_ids	list of element ids related to the zone
[in]	xyz	list of coordinates related to the zone
[out]	retvals	array of computed values

cs_meg_post_profiles()

void cs_meg_post_profiles	(	const char *	name,
		int	n_coords,
		cs_real_t	coords[][3]
	)

This function is used to define profile coordinates.

Parameters

[in]	name	name of matching profile
[in]	n_coords	number of point coordinates
[in,out]	coords	point coordinates

cs_meg_source_terms()

void cs_meg_source_terms	(	const char *	zone_name,
		const cs_lnum_t	n_elts,
		const cs_lnum_t *	elt_ids,
		const cs_real_t	xyz[][3],
		const char *	name,
		const char *	source_type,
		cs_real_t *	retvals
	)

This function is used to compute source terms over a volume zone. The mathematical expression is defined in the GUI.

The caller is responsible for freeing the returned array.

Parameters

[in]	zone_name	name of a volume zone
[in]	n_elts	number of elements related to the zone
[in]	elt_ids	list of element ids related to the zone
[in]	xyz	list of coordinates related to the zone
[in]	field_name	variable field name
[in]	source_type	source term type
[out]	retvals	array of computed values

cs_meg_volume_function()

void cs_meg_volume_function	(	const char *	zone_name,
		const cs_lnum_t	n_elts,
		const cs_lnum_t *	elt_ids,
		const cs_real_t	xyz[][3],
		const char *	fields_names,
		cs_real_t *	fvals[]
	)

This function is used to compute user defined values for fields over a given volume zone. The mathematical expression is defined in the GUI.

Parameters

[in]	zone_name	name of a volume zone
[in]	n_elts	number of elements related to the zone
[in]	elt_ids	list of element ids related to the zone
[in]	xyz	list of coordinates related to the zone
[in,out]	f	array of pointers to cs_field_t structures