API_functions.c File Reference

C API functions definitions for MMG library. More...

#include "mmgcommon.h"

Include dependency graph for API_functions.c:

Functions
void	MMG5_Init_parameters (MMG5_pMesh mesh)
void	MMG5_Init_fileNames (MMG5_pMesh mesh, MMG5_pSol sol)
int	MMG5_Set_inputMeshName (MMG5_pMesh mesh, const char *meshin)
int	MMG5_Set_inputSolName (MMG5_pMesh mesh, MMG5_pSol sol, const char *solin)
int	MMG5_Set_outputMeshName (MMG5_pMesh mesh, const char *meshout)
int	MMG5_Set_outputSolName (MMG5_pMesh mesh, MMG5_pSol sol, const char *solout)
void	MMG5_Set_constantSize (MMG5_pMesh mesh, MMG5_pSol met, double hsiz)
void	MMG5_Free_structures (MMG5_pMesh mesh, MMG5_pSol sol)
void	MMG5_mmgFree_names (MMG5_pMesh mesh, MMG5_pSol met)
int	MMG5_Set_defaultTruncatureSizes (MMG5_pMesh mesh, char sethmin, char sethmax)
int	MMG5_Compute_constantSize (MMG5_pMesh mesh, MMG5_pSol met, double *hsiz)
const char *	MMG5_Get_entitiesName (enum MMG5_entities ent)
const char *	MMG5_Get_typeName (enum MMG5_type typ)

Detailed Description

C API functions definitions for MMG library.

Author

Charles Dapogny (UPMC)

Cécile Dobrzynski (Bx INP/Inria/UBordeaux)

Pascal Frey (UPMC)

Algiane Froehly (Inria/UBordeaux)

Version

5

Date

03 2014

Copyright

GNU Lesser General Public License.

Note

This file contains some internal functions for the API, see the common/libmmgcommon.h, mmgs/libmmgs.h and mmg3d/libmmg3d.h header files for the documentation of all the usefull user's API functions.

C API for MMG library.

Function Documentation

MMG5_Compute_constantSize()

int MMG5_Compute_constantSize	(	MMG5_pMesh	mesh,
		MMG5_pSol	met,
		double *	hsize
	)

Parameters

mesh	pointer toward the mesh structure.
met	pointer toward the metric.
hsiz	computed constant size to impose.

Returns

1 if success, 0 if fail

Compute the constant size to impose according to hmin and hmax and store it in hsiz. Fill hmin and hamx if they are not setted by the user.

MMG5_Free_structures()

void MMG5_Free_structures	(	MMG5_pMesh	mesh,
		MMG5_pSol	sol
	)

Parameters

mesh	pointer toward the mesh structure.
sol	pointer toward the sol structure.

Structures unallocation before return (common structures between all codes).

MMG5_Get_entitiesName()

const char* MMG5_Get_entitiesName

(

enum MMG5_entities

ent

)

Parameters

ent	MMG5_entities enum

Returns

the name of the enum field

Print the name associated to the ent value in the MMG5_entities enum.

MMG5_Get_typeName()

const char* MMG5_Get_typeName

(

enum MMG5_type

typ

)

Parameters

typ	MMG5_type enum

Returns

the name of the enum field

Print the name associated to the typ value in the MMG5_type enum.

MMG5_Init_fileNames()

void MMG5_Init_fileNames	(	MMG5_pMesh	mesh,
		MMG5_pSol	sol
	)

Parameters

mesh	pointer toward the mesh structure.
sol	pointer toward the sol structure.

Initialize file names to their default values.

Here is the call graph for this function:

MMG5_Init_parameters()

void MMG5_Init_parameters

(

MMG5_pMesh

mesh

)

Parameters

mesh	pointer toward the mesh structure.

Initialization of the input parameters.

MMG3D_IPARAM_lag is used by mmg3d only but need to be negative in the scaleMesh function

Here is the call graph for this function:

MMG5_mmgFree_names()

void MMG5_mmgFree_names	(	MMG5_pMesh	mesh,
		MMG5_pSol	met
	)

Parameters

mesh	pointer toward the mesh structure.
met	pointer toward the sol structure.

File name deallocations before return.

MMG5_Set_constantSize()

void MMG5_Set_constantSize	(	MMG5_pMesh	mesh,
		MMG5_pSol	met,
		double	hsiz
	)

Parameters

mesh	pointer toward the mesh structure.
met	pointer toward the sol structure.
hsiz	wanted edge size

fill the metric field with the size hsiz

\Remark not for extern users.

MMG5_Set_defaultTruncatureSizes()

int MMG5_Set_defaultTruncatureSizes ( MMG5_pMesh  mesh, char  sethmin, char  sethmax  )

inline

Parameters

mesh	pointer toward the mesh structure.
sethmin	1 if hmin is already setted (>0.)
sethmax	1 if hmax is already setted (>0.)

Returns

1 if success, 0 if we detect mismatch parameters

Set default values for hmin and hmax from the bounding box.

\Remark not for extern users.

MMG5_Set_inputMeshName()

int MMG5_Set_inputMeshName	(	MMG5_pMesh	mesh,
		const char *	meshin
	)

Parameters

mesh	pointer toward the mesh structure.
meshin	input mesh name.

Returns

1 if success, 0 if fail

Set the name of input mesh.

MMG5_Set_inputSolName()

int MMG5_Set_inputSolName	(	MMG5_pMesh	mesh,
		MMG5_pSol	sol,
		const char *	solin
	)

Parameters

mesh	pointer toward the mesh structure.
sol	pointer toward the sol structure.
solin	name of the input solution file.

Returns

1 if success, 0 if fail

Set the name of input solution file.

MMG5_Set_outputMeshName()

int MMG5_Set_outputMeshName	(	MMG5_pMesh	mesh,
		const char *	meshout
	)

Parameters

mesh	pointer toward the mesh structure.
meshout	name of the output mesh file.

Returns

1 if success, 0 if fail.

Set the name of output mesh file.

MMG5_Set_outputSolName()

int MMG5_Set_outputSolName	(	MMG5_pMesh	mesh,
		MMG5_pSol	sol,
		const char *	solout
	)

Parameters

mesh	pointer toward the mesh structure.
sol	pointer toward the sol structure.
solout	name of the output solution file.

Returns

0 if failed, 1 otherwise.

Set the name of output solution file.