cs_mesh_cartesian.h File Reference

#include "cs_defs.h"

Include dependency graph for cs_mesh_cartesian.h:

Go to the source code of this file.

Enumerations
enum	cs_mesh_cartesian_law_t {   CS_MESH_CARTESIAN_CONSTANT_LAW, CS_MESH_CARTESIAN_GEOMETRIC_LAW, CS_MESH_CARTESIAN_PARABOLIC_LAW, CS_MESH_CARTESIAN_USER_LAW,   CS_MESH_CARTESIAN_N_LAW_TYPES }

Functions
cs_mesh_cartesian_params_t *	cs_mesh_cartesian_get_params (void)
	Return pointer to cartesian mesh parameters structure. More...
void	cs_mesh_cartesian_create (void)
	Create cartesian mesh structure. More...
void	cs_mesh_cartesian_define_simple (int ncells[3], cs_real_t xyz[6])
	Define a simple cartesian mesh with a constant step in all directions. More...
void	cs_mesh_cartesian_define_dir_user (int idir, int ncells, cs_real_t vtx_coord[])
	Define directions parameters based on a user input. More...
void	cs_mesh_cartesian_define_from_csv (const char *csv_file_name)
	Define a simple cartesian mesh based on a CSV file. CSV file needs to contain : (1) First line which is empty or contains a header (2) Second line containing number of vertices per direction: format is 'nx;ny;nz' (3) Third line is empty or contains a header (4) Fourth line and onwards contains vertices coordinates for each direction. Format is "X1[i];X2[i];X3[i]" for index i. If current vertex index is beyond max value for a given direction, an empty value is expected. For example, if for index 'j' the first direction is empty, format is : ';X2[j];X3[j]'. More...
void	cs_mesh_cartesian_define_dir_params (int idim, cs_mesh_cartesian_law_t law, int ncells, cs_real_t smin, cs_real_t smax, cs_real_t progression)
	Define parameters for a given direction. More...
int	cs_mesh_cartesian_need_build (void)
	Indicate if a cartesian mesh is to be built. More...
int	cs_mesh_cartesian_get_ncells (int idim)
	Get number of cells in a given direction. More...
void	cs_mesh_cartesian_connectivity (cs_mesh_t *m, cs_mesh_builder_t *mb, long echo)
	Build unstructured connectivity needed for partitionning. More...
void	cs_mesh_cartesian_params_destroy (void)
	Destroy cartesian mesh parameters. More...

Enumeration Type Documentation

cs_mesh_cartesian_law_t

enum cs_mesh_cartesian_law_t

Enumerator
CS_MESH_CARTESIAN_CONSTANT_LAW
CS_MESH_CARTESIAN_GEOMETRIC_LAW
CS_MESH_CARTESIAN_PARABOLIC_LAW
CS_MESH_CARTESIAN_USER_LAW
CS_MESH_CARTESIAN_N_LAW_TYPES

Function Documentation

cs_mesh_cartesian_connectivity()

void cs_mesh_cartesian_connectivity	(	cs_mesh_t *	m,
		cs_mesh_builder_t *	mb,
		long	echo
	)

Build unstructured connectivity needed for partitionning.

Parameters

[in]	m	pointer to cs_mesh_t structure
[in]	mb	pointer to cs_mesh_builder_t structure
[in]	echo	verbosity flag

cs_mesh_cartesian_create()

void cs_mesh_cartesian_create

(

void

)

Create cartesian mesh structure.

cs_mesh_cartesian_define_dir_params()

void cs_mesh_cartesian_define_dir_params	(	int	idim,
		cs_mesh_cartesian_law_t	law,
		int	ncells,
		cs_real_t	smin,
		cs_real_t	smax,
		cs_real_t	progression
	)

Define parameters for a given direction.

Parameters

[in]	idim	Geometrical direction: 0->X, 1->Y, 2->Z
[in]	law	1D discretization law: constant, geometric or parabolic
[in]	ncells	Number of cells for this direction
[in]	smin	Min coordinate value for this direction
[in]	smax	Max coordinate value for this direction
[in]	progression	Progression value, only used for geometric or parabolic laws.

cs_mesh_cartesian_define_dir_user()

void cs_mesh_cartesian_define_dir_user	(	int	idir,
		int	ncells,
		cs_real_t	vtx_coord[]
	)

Define directions parameters based on a user input.

Parameters

[in]	idir	Direction index. 0->X, 1->Y, 2->Z
[in]	ncells	Number of cells for the direction
[in]	vtx_coord	Array of size ncells+1 containing 1D coordinate values for vertices on the given direction

cs_mesh_cartesian_define_from_csv()

void cs_mesh_cartesian_define_from_csv

(

const char *

csv_file_name

)

Define a simple cartesian mesh based on a CSV file. CSV file needs to contain : (1) First line which is empty or contains a header (2) Second line containing number of vertices per direction: format is 'nx;ny;nz' (3) Third line is empty or contains a header (4) Fourth line and onwards contains vertices coordinates for each direction. Format is "X1[i];X2[i];X3[i]" for index i. If current vertex index is beyond max value for a given direction, an empty value is expected. For example, if for index 'j' the first direction is empty, format is : ';X2[j];X3[j]'.

Parameters

[in]

csv_file_name

name of CSV file containing mesh information.

cs_mesh_cartesian_define_simple()

void cs_mesh_cartesian_define_simple	(	int	ncells[3],
		cs_real_t	xyz[6]
	)

Define a simple cartesian mesh with a constant step in all directions.

Parameters

[in]	ncells	Array of size 3 containing number of cells in each direction
[in]	xyz	Array of size 6 containing min values, followed by max values for the three directions.

cs_mesh_cartesian_get_ncells()

int cs_mesh_cartesian_get_ncells

(

int

idim

)

Get number of cells in a given direction.

Parameters

[in]

idim

Index of direction: 0->X, 1->Y, 2->Z

Returns

Number of cells in corresponding direction (int)

cs_mesh_cartesian_get_params()

cs_mesh_cartesian_params_t* cs_mesh_cartesian_get_params

(

void

)

Return pointer to cartesian mesh parameters structure.

Returns

pointer to cs_mesh_cartesian_params_t structure

cs_mesh_cartesian_need_build()

int cs_mesh_cartesian_need_build

(

void

)

Indicate if a cartesian mesh is to be built.

Returns

1 if mesh needs to be built, 0 otherwise

cs_mesh_cartesian_params_destroy()

void cs_mesh_cartesian_params_destroy

(

void

)

Destroy cartesian mesh parameters.