add comments

arcaneframework · Aug 30, 2024 · e380011 · e380011
1 parent bf55be6
commit e380011
Show file tree

Hide file tree

Showing 6 changed files with 273 additions and 56 deletions.
diff --git a/fourier/Test.conduction.10k.arc b/fourier/Test.conduction.10k.arc
@@ -1,24 +1,42 @@
 <?xml version="1.0"?>
+<!--
+  Case configuration for a Fourier analysis simulation.
+  This file includes settings for:
+    - General simulation parameters
+    - Mesh configuration details
+    - Finite Element Method (FEM) configurations
+    - Post-processing options
+-->
 <case codename="Fourier" xml:lang="en" codeversion="1.0">
+
+  <!--
+    Arcane-specific settings:
+      - title: Descriptive name for the simulation case.
+      - timeloop: Specifies the time-stepping loop used in this Fourier simulation.
+  -->
   <arcane>
-    <title>Sample</title>
+    <title>Fouriers equation FEM code fine mesh</title>
     <timeloop>FourierLoop</timeloop>
   </arcane>
 
-  <arcane-post-processing>
-   <output-period>1</output-period>
-   <format name="VtkHdfV2PostProcessor" />
-   <output>
-     <variable>U</variable>
-   </output>
-  </arcane-post-processing>
-
+  <!--
+    Mesh configuration:
+      - filename: The path to the mesh file used in the simulation.
+  -->
   <meshes>
     <mesh>
       <filename>plancher.10k.msh</filename>
     </mesh>
   </meshes>
 
+  <!--
+    FEM (Finite Element Method) settings:
+      - lambda: Thermal conductivity or diffusivity coefficient.
+      - qdot: Heat source term or volumetric heat generation.
+      - boundary-conditions: Defines the boundary conditions for the simulation.
+        - dirichlet: Fixed value boundary condition with penalty enforcement for specified surfaces.
+        - neumann: Flux or gradient boundary condition for specified surfaces.
+  -->
   <fem>
     <lambda>1.75</lambda>
     <qdot>1e5</qdot>
@@ -51,4 +69,19 @@
       </neumann>
     </boundary-conditions>
   </fem>
+
+  <!--
+    Post-processing settings:
+      - output-period: Defines how often (in simulation steps) the output is generated.
+      - format: Specifies the post-processing format, here using VtkHdfV2.
+      - output: Defines the variables to be included in the post-processing output.
+  -->
+  <arcane-post-processing>
+   <output-period>1</output-period>
+   <format name="VtkHdfV2PostProcessor" />
+   <output>
+     <variable>U</variable>
+   </output>
+  </arcane-post-processing>
+
 </case>
diff --git a/fourier/Test.conduction.arc b/fourier/Test.conduction.arc
@@ -1,24 +1,43 @@
 <?xml version="1.0"?>
+<!--
+  Case configuration for a Fourier analysis simulation.
+  This file includes settings for:
+    - General simulation parameters
+    - Mesh configuration details
+    - Finite Element Method (FEM) configurations
+    - Post-processing options
+-->
 <case codename="Fourier" xml:lang="en" codeversion="1.0">
+
+  <!--
+    Arcane-specific settings:
+      - title: Descriptive name for the simulation case.
+      - timeloop: Specifies the time-stepping loop used in this Fourier simulation.
+  -->
   <arcane>
-    <title>Sample</title>
+    <title>Fouriers equation FEM code</title>
     <timeloop>FourierLoop</timeloop>
   </arcane>
 
-  <arcane-post-processing>
-   <output-period>1</output-period>
-   <format name="VtkHdfV2PostProcessor" />
-   <output>
-     <variable>U</variable>
-   </output>
-  </arcane-post-processing>
-
+  <!--
+    Mesh configuration:
+      - filename: The path to the mesh file used in the simulation.
+  -->
   <meshes>
     <mesh>
       <filename>plancher.msh</filename>
     </mesh>
   </meshes>
 
+  <!--
+    FEM (Finite Element Method) settings:
+      - lambda: Thermal conductivity or diffusivity coefficient.
+      - qdot: Heat source term or volumetric heat generation.
+      - result-file: File where simulation results will be saved.
+      - boundary-conditions: Defines the boundary conditions for the simulation.
+        - dirichlet: Fixed value boundary condition with penalty enforcement for specified surfaces.
+        - neumann: Flux or gradient boundary condition for specified surfaces.
+  -->
   <fem>
     <lambda>1.75</lambda>
     <qdot>1e5</qdot>
@@ -52,4 +71,19 @@
       </neumann>
     </boundary-conditions>
   </fem>
+
+  <!--
+    Post-processing settings:
+      - output-period: Defines how often (in simulation steps) the output is generated.
+      - format: Specifies the post-processing format, here using VtkHdfV2.
+      - output: Defines the variables to be included in the post-processing output.
+  -->
+  <arcane-post-processing>
+   <output-period>1</output-period>
+   <format name="VtkHdfV2PostProcessor" />
+   <output>
+     <variable>U</variable>
+   </output>
+  </arcane-post-processing>
+
 </case>
diff --git a/fourier/Test.conduction.heterogeneous.10k.arc b/fourier/Test.conduction.heterogeneous.10k.arc
@@ -1,24 +1,46 @@
 <?xml version="1.0"?>
+<!--
+  Case configuration for a Fourier analysis simulation.
+  This configuration file contains settings for:
+    - General simulation parameters
+    - Mesh configuration details
+    - Finite Element Method (FEM) configurations
+    - Post-processing options
+-->
 <case codename="Fourier" xml:lang="en" codeversion="1.0">
+
+  <!--
+    Arcane-specific settings:
+      - title: Descriptive name for the simulation case.
+      - timeloop: Specifies the time-stepping loop used in this Fourier simulation.
+  -->
   <arcane>
-    <title>Sample</title>
+    <title>Fouriers equation FEM code with heterogenous material and fine mesh</title>
     <timeloop>FourierLoop</timeloop>
   </arcane>
 
-  <arcane-post-processing>
-   <output-period>1</output-period>
-   <format name="VtkHdfV2PostProcessor" />
-   <output>
-     <variable>U</variable>
-   </output>
-  </arcane-post-processing>
-
+  <!--
+    Mesh configuration:
+      - filename: The path to the mesh file used in the simulation.
+      - The mesh file is designed for multi-material analysis with a 10,000-element mesh.
+  -->
   <meshes>
     <mesh>
       <filename>multi-material.10k.msh</filename>
     </mesh>
   </meshes>
 
+  <!--
+    FEM (Finite Element Method) settings:
+      - lambda: Default thermal conductivity or diffusivity coefficient for the simulation.
+      - qdot: Specifies the heat source term or volumetric heat generation.
+      - boundary-conditions: Defines the boundary conditions for the simulation, including Dirichlet and Neumann conditions.
+        - dirichlet: Applies fixed value boundary conditions to specified surfaces.
+        - neumann: Applies flux or gradient boundary conditions to specified surfaces.
+      - material-property: Specifies the material properties for different volumes in the mesh, allowing for multi-material simulations.
+        - volume: Identifies the material volume within the mesh.
+        - lambda: Specifies the thermal conductivity or diffusivity for the corresponding material.
+  -->
   <fem>
     <lambda>0.0</lambda>
     <qdot>15.</qdot>
@@ -49,4 +71,19 @@
       <lambda>1.0</lambda>
     </material-property>
   </fem>
+
+  <!--
+    Post-processing settings:
+      - output-period: Determines how often (in simulation steps) the output is generated.
+      - format: Specifies the output format, here using VtkHdfV2.
+      - output: Defines the variables to be included in the post-processing output.
+  -->
+  <arcane-post-processing>
+   <output-period>1</output-period>
+   <format name="VtkHdfV2PostProcessor" />
+   <output>
+     <variable>U</variable>
+   </output>
+  </arcane-post-processing>
+
 </case>
diff --git a/fourier/Test.conduction.heterogeneous.arc b/fourier/Test.conduction.heterogeneous.arc
@@ -1,24 +1,47 @@
 <?xml version="1.0"?>
+<!--
+  Case configuration for a Fourier analysis simulation.
+  The XML file includes sections for:
+    - General simulation settings
+    - Mesh configuration details
+    - Finite Element Method (FEM) configurations
+    - Post-processing options
+-->
 <case codename="Fourier" xml:lang="en" codeversion="1.0">
+
+  <!--
+    Arcane-specific settings:
+      - title: A descriptive name for the case.
+      - timeloop: Defines the specific time-stepping loop used for this Fourier simulation.
+  -->
   <arcane>
-    <title>Sample</title>
+    <title>Fouriers equation FEM code with heterogenous material</title>
     <timeloop>FourierLoop</timeloop>
   </arcane>
 
-  <arcane-post-processing>
-   <output-period>1</output-period>
-   <format name="VtkHdfV2PostProcessor" />
-   <output>
-     <variable>U</variable>
-   </output>
-  </arcane-post-processing>
-
+  <!--
+    Mesh configuration:
+      - filename: Path to the mesh file used in the simulation.
+      - The mesh file is configured for a multi-material simulation.
+  -->
   <meshes>
     <mesh>
       <filename>multi-material.msh</filename>
     </mesh>
   </meshes>
 
+  <!--
+    FEM (Finite Element Method) settings:
+      - lambda: Default thermal conductivity or diffusivity coefficient.
+      - qdot: Heat source term or volumetric heat generation.
+      - result-file: File to which simulation results will be written.
+      - boundary-conditions: Defines the boundary conditions for the simulation.
+        - dirichlet: Fixed value boundary condition for specific surfaces.
+        - neumann: Flux or gradient boundary condition for specific surfaces.
+      - material-property: Specifies material properties, like thermal conductivity, for different volumes in the mesh.
+        - volume: Name of the material volume within the mesh.
+        - lambda: Thermal conductivity or diffusivity for the specified material.
+  -->
   <fem>
     <lambda>0.0</lambda>
     <qdot>15.</qdot>
@@ -50,4 +73,19 @@
       <lambda>1.0</lambda>
     </material-property>
   </fem>
+
+  <!--
+    Post-processing settings:
+      - output-period: Defines the frequency (in simulation steps) at which output is generated.
+      - format: Specifies the post-processing format, in this case, VtkHdfV2.
+      - output: Lists the variables to be output during post-processing.
+  -->
+  <arcane-post-processing>
+   <output-period>1</output-period>
+   <format name="VtkHdfV2PostProcessor" />
+   <output>
+     <variable>U</variable>
+   </output>
+  </arcane-post-processing>
+
 </case>
diff --git a/fourier/Test.conduction.quad4.arc b/fourier/Test.conduction.quad4.arc
@@ -1,24 +1,43 @@
 <?xml version="1.0"?>
+<!--
+  Case configuration for a Fourier analysis simulation.
+  The XML file includes sections for:
+    - General simulation settings
+    - Mesh configuration details
+    - Finite Element Method (FEM) configurations
+    - Post-processing options
+-->
 <case codename="Fourier" xml:lang="en" codeversion="1.0">
+
+  <!--
+    Arcane-specific settings:
+      - title: A descriptive name for the case.
+      - timeloop: Defines the specific time-stepping loop used for this Fourier simulation.
+  -->
   <arcane>
-    <title>Sample</title>
+    <title>Fouriers equation FEM code with quad mesh</title>
     <timeloop>FourierLoop</timeloop>
   </arcane>
 
-  <arcane-post-processing>
-   <output-period>1</output-period>
-   <format name="VtkHdfV2PostProcessor" />
-   <output>
-     <variable>U</variable>
-   </output>
-  </arcane-post-processing>
-
+  <!--
+    Mesh configuration:
+      - filename: Path to the mesh file used in the simulation.
+  -->
   <meshes>
     <mesh>
       <filename>plancher.quad4.msh</filename>
     </mesh>
   </meshes>
 
+  <!--
+    FEM (Finite Element Method) settings:
+      - lambda: Thermal conductivity or diffusivity coefficient.
+      - qdot: Heat source term or volumetric heat generation.
+      - mesh-type: Specifies the type of mesh used in the simulation (e.g., QUAD4).
+      - boundary-conditions: Defines the boundary conditions for the simulation.
+        - dirichlet: Fixed value boundary condition for specific surfaces.
+        - neumann: Flux or gradient boundary condition for specific surfaces.
+  -->
   <fem>
     <lambda>1.75</lambda>
     <qdot>1e5</qdot>
@@ -46,4 +65,19 @@
       </neumann>
     </boundary-conditions>
   </fem>
-</case>
+
+  <!--
+    Post-processing settings:
+      - output-period: Defines the frequency (in simulation steps) at which output is generated.
+      - format: Specifies the post-processing format, in this case, VtkHdfV2.
+      - output: Lists the variables to be output during post-processing.
+  -->
+  <arcane-post-processing>
+   <output-period>1</output-period>
+   <format name="VtkHdfV2PostProcessor" />
+   <output>
+     <variable>U</variable>
+   </output>
+  </arcane-post-processing>
+
+</case>