Arcane

Logo du CEA et logo de l'IFPEN

Cette page contient la documentation pour les utilisateurs de la plate-forme Arcane.

La page Nouveautés et changements présente la liste des nouveautés de chaque version.

La documentation accessible depuis cette page s'adresse aux personnes désirant connaitre les fonctionnalités de la plate-forme Arcane ou souhaitant développer des modules ou services capables de s'exécuter sur la plate-forme Arcane.

Toutes les personnes développant des modules ou services pour Arcane doivent connaitre au minimum les documents Débuter avec Arcane et Types fondamentaux. Ensuite, pour avoir le détail des opérations d'une classe, par exemple pour connaitre l'ensemble des méthodes de la classe Arcane::Cell, il faut consulter la documentation en ligne des codes sources de Arcane.

La documentation se compose de chapitres (listés ci-dessous), composés eux-mêmes de sous-chapitres et/ou de pages.

Chaque chapitre/sous-chapitre dispose d'un sommaire décrivant brièvement son contenu et d'une liste de ces pages.

Pour configurer la documentation, c'est ici : Personnalisation de la doc

Les chapitres disponibles sont :

• Compilation et installation
  Présente comment compiler et installer le framework Arcane.
• Débuter avec Arcane
  Présente brièvement les principes et les types de base de Arcane.
• Types fondamentaux
  Présente les notions clefs de Arcane (modules, variables, points d'entrée, services et les différents types de fichiers).
• Exécution, runtime
  Présente les éléments à connaitre pour faire fonctionner un code Arcane (lancement d'un calcul, variables d'environnement).
• Généralités
  Présente des éléments à savoir comme les règles de codage.
• Exemples et didacticiel
  Présente des exemples Arcane.
• Paralléliser un code
  Présente les différents moyens de paralléliser un code Arcane.
• API accélérateur
  Présente les mécanismes disponibles dans Arcane pour pouvoir utiliser les accélérateurs (GPU) dans Arcane.
• Matériaux et milieux
  Présente la partie matériau de Arcane.
• Entrées / sorties (IO)
  Présente les différents moyens d'entrer et de sortir des données.
• Debug, performance et validation
  Présente les divers méthodes permettant d'aider au débuggage, à l'analyse des performances, au tests unitaires et à la validation de code.
• Utilisation d'autres langages
  Présente les autres langages avec lesquelles Arcane peut se coupler (aujourd'hui, uniquement le C#).
• Entités, maillages et connectivités
  Présente les entités disponibles dans Arcane (types de mailles prédéfinis, maillage, connectivités des entités et description classes gérant la géométrie).
• Services et modules disponibles
  Présente les services et les modules mis à disposition des utilisateurs
• Glossaire
  Glossaire des concepts principaux de Arcane (sous-domaine, maillage, maillage cartésien, élément de maillage, famille d'éléments, groupe d'éléments, gestionnaire parallèle, variable, gestionnaire de variable, module, service, gestionnaire de matériaux, matériau, constituant, milieu et bloc).