Arcane  4.2.3.0
User documentation
Loading...
Searching...
No Matches
Service 'ArcaneCaseMeshService'

Service Arcane allowing the reading or creation of a mesh.
An instance of this service is created for each <mesh> element of the <meshes> element of the data set (see Service 'ArcaneCaseMeshMasterService'). The meshes are named Mesh0, Mesh1, ... in the order of appearance of the <mesh> elements. The first mesh (Mesh0) is the default mesh of the sub-domain.
Only one of the two tags <filename> or <generator> must be specified. If <filename> is specified, the mesh will be read from the specified file. If it is <generator>, the mesh will be generated directly online from one of the generators available in Arcane.
The tag <partitioner> indicates the partitioner to use for the initial partitioning. The value External indicates that the partitioning has already been done. In this case, the mesh files will be named CPU%05d.<ext> where '%05d' is the rank of the process (zero-padded on 5 digits).
The variables of the mesh can be initialized with the <initialization> tag.
A complete description of the mesh specification in the data set is available in Meshes (tag <meshes>).
For example:

<meshes>
<mesh>
<generator name="Cartesian3D">
<x><n>100</n><length>2.0</length></x>
<y><n>15</n><length>2.0</length></y>
<z><n>10</n><length>4.0</length></z>
</generator>
<initialization>
<variable>
<name>Density</name>
<value>1.0</value>
<group>ZG</group>
</variable>
</initialization>
</mesh>
</meshes>

Interfaces

Liste des options

Documentation des options

filename (string)

Mesh file name. If it is not defined, a mesh generator must be specified.
The mesh reading service is automatically detected from the extension of the file. The following formats are supported by Arcane (the list depends on the compile options): .vtk (legacy VTK), .vtu (XML VTK, with or without support for polyhedral cells), .msh (Gmsh), .med (MED, requires HDF5 support), and the Lima formats .unf, .mli, .mli2, .ice, .uns and .unv (requires Lima support).
A specific reader can be specified with the <specific-reader> tag.
Simple

<filename>value</filename>

generator (Arcane::IMeshBuilder)

Mesh creation service.
This service must be specified if no mesh file is defined. The name of the service is given by the name attribute. The following generators are available in Arcane (the list depends on the compile options):

  • Cartesian2D: 2D Cartesian mesh generator;
  • Cartesian3D: 3D Cartesian mesh generator;
  • Sod3D: Sod shock tube mesh generator;
  • HoneyComb2D: 2D hexagonal mesh generator;
  • HoneyComb3D: 3D hexagonal mesh generator.
    For example:
    <generator name="Cartesian2D">
    <origin>0.0 0.0</origin>
    <x><n>20</n><length>1.0</length></x>
    <y><n>10</n><length>1.0</length></y>
    </generator>
Valeurs possibles pour le tag name :
Cartesian3D
Liste des options du service Cartesian3D :

Cartesian2D
Liste des options du service Cartesian2D :

Sod3D
Liste des options du service Sod3D :

HoneyComb3D
Liste des options du service HoneyComb3D :

HoneyComb2D
Liste des options du service HoneyComb2D :

Service Instance

<generator name='value'>service configuration block</generator>

initialization

Initialization information.
These options allow, among other things, initializing variables on groups with predefined values. It contains a list of <variable> elements. For example:

<initialization>
<variable>
<name>Density</name>
<value>1.0</value>
<group>ZG</group>
</variable>
<variable>
<name>Density</name>
<value>0.125</value>
<group>ZD</group>
</variable>
</initialization>

Complex

initialization/variable [0... undefined]

List of variables to initialize.
Complex

initialization/variable/group (string)

Name of the group on which we want to position the values.
Simple

<group>value</group>

initialization/variable/name (string)

Name of the variable to initialize.
Simple

<name>value</name>

initialization/variable/value (string)

Value of the variable. The string must be convertible to the variable type.
Simple

<value>value</value>

mesh-builder-customiser (Arcane::IMeshBuilderCustomiser)

Specific service to customise the creation of the mesh.
It may be used for example to set a specific instance of the parallel manager. For example, the ArcaneParallelMngSplitterMeshBuilderCustomiser service creates the mesh on a subset of the ranks (option subset-ratio).
Valeur possible pour le tag name :
ArcaneParallelMngSplitterMeshBuilderCustomiser
Liste des options du service ArcaneParallelMngSplitterMeshBuilderCustomiser :

Service Instance

<mesh-builder-customiser name='value'>service configuration block</mesh-builder-customiser>

nb-ghost-layer (int32=1)

Number of ghost cell layers to add to the mesh in case of partitioning.
Simple

<nb-ghost-layer>value</nb-ghost-layer>

partitioner (string=DefaultPartitioner)

Name of the partitioning service to use for the initial decomposition.
If the value is 'External', it is considered that the partitioning has already been performed before the code is launched. In this case, already partitioned mesh files must be available. These files must be named CPU%05d.<ext> where '%05d' is the rank of the process (zero-padded on 5 digits) and <ext> is the extension of the mesh file.
Simple

<partitioner>value</partitioner>

specific-reader (Arcane::ICaseMeshReader)

Specific mesh reading service.
This service can be specified if you wish to avoid automatic detection of the reader to be used or if you wish to add specific options to a given reader. For example, the VtkPolyhedralCaseMeshReader service supports polyhedral cells and has options to print information about the mesh:

<meshes>
<mesh>
<filename>mesh.vtk</filename>
<specific-reader name="VtkPolyhedralCaseMeshReader">
<print-mesh-infos>true</print-mesh-infos>
</specific-reader>
</mesh>
</meshes>

Service Instance

<specific-reader name='value'>service configuration block</specific-reader>

subdivider (Arcane::IMeshSubdivider=ArcaneBasicMeshSubdivider)

Service allowing the subdivision of cells.
The default service (ArcaneBasicMeshSubdivider) has one option, nb-subdivision, which is the number of subdivisions to apply to each cell.
Valeur possible pour le tag name :
ArcaneBasicMeshSubdivider
Liste des options du service ArcaneBasicMeshSubdivider :

Service Instance

<subdivider name='value'>service configuration block</subdivider>