My Project
programmer's documentation
Functions
cs_mesh_location.c File Reference
#include "cs_defs.h"
#include <assert.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "bft_mem.h"
#include "bft_error.h"
#include "bft_printf.h"
#include "fvm_selector.h"
#include "cs_halo.h"
#include "cs_parall.h"
#include "cs_mesh.h"
#include "cs_sort.h"
#include "cs_mesh_location.h"
Include dependency graph for cs_mesh_location.c:

Functions

static cs_mesh_location_t_mesh_location_by_id (int id)
 
static const cs_mesh_location_t_const_mesh_location_by_id (int id)
 
static int _find_id_by_name (const char *ref_name)
 Find the related location id from the location name. More...
 
static int _mesh_location_define (const char *name, cs_mesh_location_type_t type)
 
static void _build_by_ml_ids (cs_mesh_location_t *ml)
 
int cs_mesh_location_n_locations (void)
 Return number of mesh locations defined. More...
 
void cs_mesh_location_initialize (void)
 Initialize mesh location API. More...
 
void cs_mesh_location_finalize (void)
 Finalize mesh location API. More...
 
void cs_mesh_location_build (cs_mesh_t *mesh, int id)
 Associate mesh locations with a mesh. More...
 
int cs_mesh_location_add (const char *name, cs_mesh_location_type_t type, const char *criteria)
 Define a new mesh location. More...
 
int cs_mesh_location_add_by_func (const char *name, cs_mesh_location_type_t type, cs_mesh_location_select_t *func, void *input)
 Define a new mesh location with an associated selection function. More...
 
int cs_mesh_location_add_by_union (const char *name, cs_mesh_location_type_t type, int n_ml_ids, const int *ml_ids, bool complement)
 Define a new mesh location. More...
 
int cs_mesh_location_get_id_by_name (const char *ref_name)
 Find the related location id from the location name. More...
 
const char * cs_mesh_location_get_name (int id)
 Get a mesh location's name. More...
 
cs_mesh_location_type_t cs_mesh_location_get_type (int id)
 Get a mesh location's type. More...
 
const cs_lnum_tcs_mesh_location_get_n_elts (int id)
 Get a mesh location's number of elements. More...
 
const cs_lnum_tcs_mesh_location_get_elt_list (int id)
 Get a mesh location's elements list, if present. More...
 
const cs_lnum_tcs_mesh_location_get_elt_ids_try (int id)
 Get a mesh location's element ids, if present. More...
 
const cs_lnum_tcs_mesh_location_get_elt_ids (int id)
 Get a mesh location's element ids. More...
 
const char * cs_mesh_location_get_selection_string (int id)
 Get a mesh location's selection criteria string. More...
 
cs_mesh_location_select_tcs_mesh_location_get_selection_function (int id)
 Get a mesh location's selection function pointer. More...
 
bool cs_mesh_location_get_explicit_ids (int id)
 Check if cs_mesh_location_get_elt_ids always returns explicit element ids for a given mesh location type. More...
 
void cs_mesh_location_set_explicit_ids (int id, bool explicit_elt_ids)
 Set behavior of cs_mesh_location_get_elt_ids for mesh mesh location type. More...
 

Function Documentation

◆ _build_by_ml_ids()

static void _build_by_ml_ids ( cs_mesh_location_t ml)
static

◆ _const_mesh_location_by_id()

static const cs_mesh_location_t* _const_mesh_location_by_id ( int  id)
static

◆ _find_id_by_name()

static int _find_id_by_name ( const char *  ref_name)
static

Find the related location id from the location name.

Parameters
[in]ref_namename of the location to find
Returns
-1 if not found otherwise the associated id

◆ _mesh_location_by_id()

static cs_mesh_location_t* _mesh_location_by_id ( int  id)
static

◆ _mesh_location_define()

static int _mesh_location_define ( const char *  name,
cs_mesh_location_type_t  type 
)
static

◆ cs_mesh_location_add()

int cs_mesh_location_add ( const char *  name,
cs_mesh_location_type_t  type,
const char *  criteria 
)

Define a new mesh location.

So as to define a subset of mesh entities of a given type, an optional selection criteria may be given.

Parameters
[in]namename of location to define
[in]typetype of location to define
[in]criteriaselection criteria for associated elements, or NULL
Returns
id of newly defined created mesh location

◆ cs_mesh_location_add_by_func()

int cs_mesh_location_add_by_func ( const char *  name,
cs_mesh_location_type_t  type,
cs_mesh_location_select_t func,
void *  input 
)

Define a new mesh location with an associated selection function.

So as to define a subset of mesh entities of a given type, a pointer to a selection function may be given.

This requires more programming but allows finer control than selection criteria, as the function has access to the complete mesh structure.

Parameters
[in]namename of location to define
[in]typetype of location to define
[in]funcpointer to selection function for associated elements, or NULL
[in,out]inputpointer to optional (untyped) value or structure.
Returns
id of newly defined created mesh location

◆ cs_mesh_location_add_by_union()

int cs_mesh_location_add_by_union ( const char *  name,
cs_mesh_location_type_t  type,
int  n_ml_ids,
const int *  ml_ids,
bool  complement 
)

Define a new mesh location.

So as to define a subset of mesh entities of a given type, a list of ids related to existing mesh locations may be given

Parameters
[in]namename of location to define
[in]typetype of location to define
[in]n_ml_idsnumber of mesh location ids
[in]ml_idslist of mesh location ids
[in]complementtake the complement of the selected entities if true
Returns
id of newly created mesh location

◆ cs_mesh_location_build()

void cs_mesh_location_build ( cs_mesh_t mesh,
int  id 
)

Associate mesh locations with a mesh.

If mesh_id is negative, all defined mesh locations are associated (which is useful for the common case where only one mesh is present). If mesh_id is non-negative, only the location with the matching id is associated (which may be useful when multiple meshes are defined).

The number of elements are computed based on the underlying mesh, and element lists are built for mesh subset locations.

Parameters
[in]meshpointer to associated mesh structure
[in]idid of mesh location

◆ cs_mesh_location_finalize()

void cs_mesh_location_finalize ( void  )

Finalize mesh location API.

◆ cs_mesh_location_get_elt_ids()

const cs_lnum_t* cs_mesh_location_get_elt_ids ( int  id)

Get a mesh location's element ids.

This function may only be used with a given location if cs_mesh_location_set_explicit_ids has been used to indicate explicit ids are needed for this location type.

Parameters
[in]idid of mesh location
Returns
pointer to elements array (0 to n-1 numbering).

◆ cs_mesh_location_get_elt_ids_try()

const cs_lnum_t* cs_mesh_location_get_elt_ids_try ( int  id)

Get a mesh location's element ids, if present.

An array of element ids is returned if the location is a subset of a main main location type, and NULL is returned when the id array would map to the identity function (i.e. {0, 1, 2, ..., n_elts-1}).

Parameters
[in]idid of mesh location
Returns
pointer to elements array (0 to n-1 numbering).

◆ cs_mesh_location_get_elt_list()

const cs_lnum_t* cs_mesh_location_get_elt_list ( int  id)

Get a mesh location's elements list, if present.

A list of elements is defined if the location is a subset of a main location type.

Deprecated:
Use cs_mesh_location_get_elt_ids_try or cs_mesh_location_get_elt_ids instead.
Parameters
[in]idid of mesh location
Returns
pointer to elements array (0 to n-1 numbering).

◆ cs_mesh_location_get_explicit_ids()

bool cs_mesh_location_get_explicit_ids ( int  id)

Check if cs_mesh_location_get_elt_ids always returns explicit element ids for a given mesh location type.

Check if cs_mesh_location_get_elt_ids always returns explicit element ids for a given mesh location.

Parameters
[in]idid or type of location
Returns
true if explicit element ids are needed, false otherwise

◆ cs_mesh_location_get_id_by_name()

int cs_mesh_location_get_id_by_name ( const char *  ref_name)

Find the related location id from the location name.

Parameters
[in]ref_namename of the location to find
Returns
-1 if not found otherwise the associated id

◆ cs_mesh_location_get_n_elts()

const cs_lnum_t* cs_mesh_location_get_n_elts ( int  id)

Get a mesh location's number of elements.

A pointer to a array of 3 values is returned: 0: local number of elements 1: with standard ghost elements (if applicable) 2: with extended ghost elements (if applicable)

Parameters
[in]idid of mesh location
Returns
array of numbers of elements.

◆ cs_mesh_location_get_name()

const char* cs_mesh_location_get_name ( int  id)

Get a mesh location's name.

Parameters
[in]idid of mesh location
Returns
pointer to mesh location name

◆ cs_mesh_location_get_selection_function()

cs_mesh_location_select_t* cs_mesh_location_get_selection_function ( int  id)

Get a mesh location's selection function pointer.

Parameters
[in]idid of mesh location
Returns
pointer to mesh location selection function pointer, or NULL

◆ cs_mesh_location_get_selection_string()

const char* cs_mesh_location_get_selection_string ( int  id)

Get a mesh location's selection criteria string.

Parameters
[in]idid of mesh location
Returns
pointer to mesh location selection criteria, or NULL

◆ cs_mesh_location_get_type()

cs_mesh_location_type_t cs_mesh_location_get_type ( int  id)

Get a mesh location's type.

Parameters
[in]idid of mesh location
Returns
mesh location type

◆ cs_mesh_location_initialize()

void cs_mesh_location_initialize ( void  )

Initialize mesh location API.

By default, 7 mesh locations are built, matching the 7 first values of the cs_mesh_location_type_t enum: CS_MESH_LOCATION_NONE for global values, CS_MESH_LOCATION_CELLS for the cells of the (default) global mesh, CS_MESH_LOCATION_INTERIOR_FACES and CS_MESH_LOCATION_BOUNDARY_FACES for its faces, and CS_MESH_LOCATION_VERTICES for its vertices. CS_MESH_LOCATION_FACES and a placeholder for CS_MESH_LOCATION_EDGES are also added for CDO discretizations.

Locations should then be built once the global mesh is complete, and its halo structures completed.

◆ cs_mesh_location_n_locations()

int cs_mesh_location_n_locations ( void  )

Return number of mesh locations defined.

Returns
number of mesh locations defined

◆ cs_mesh_location_set_explicit_ids()

void cs_mesh_location_set_explicit_ids ( int  id,
bool  explicit_elt_ids 
)

Set behavior of cs_mesh_location_get_elt_ids for mesh mesh location type.

Set behavior of cs_mesh_location_get_elt_ids for a given mesh location and locations based on it.

Parameters
[in]idid or type of location
[in]explicit_elt_idsindicate if explicit element ids are needed