From 26e72ac4375c01917a69d0446556c66ba548695c Mon Sep 17 00:00:00 2001
From: Simon Ans <simon.ans34@gmail.com>
Date: Mon, 18 Mar 2024 09:05:12 +0000
Subject: [PATCH] adding the link to the TopOpt article (SA, FZ, GD)

---
 DiffractionGratingsTopOpt/README.md               | 6 +++---
 DiffractionGratingsTopOpt/resolution_functions.py | 7 +++++++
 DiffractionGratingsTopOpt/topopt_conical.geo      | 4 ++--
 DiffractionGratingsTopOpt/topopt_conical.pro      | 8 ++++----
 4 files changed, 16 insertions(+), 9 deletions(-)

diff --git a/DiffractionGratingsTopOpt/README.md b/DiffractionGratingsTopOpt/README.md
index bd9c9a6..c21858e 100644
--- a/DiffractionGratingsTopOpt/README.md
+++ b/DiffractionGratingsTopOpt/README.md
@@ -1,8 +1,8 @@
-# Directory in git repository : ```src_blaze/PhD/Maxwell_solvers/meshGrating_topopt_conical```
+# Topology optimization of blazed gratings under conical incidence
 
 File : ```README.md```\
 Author : ©Simon Ans\
-Last update : 05/03/2024\
+Last update : 18/03/2024\
 To get a pdf file from this ```.md``` file, run in a shell terminal :
 
 > ```pandoc README.md --pdf-engine=xelatex -o README.pdf```
@@ -13,7 +13,7 @@ To get a pdf file from this ```.md``` file, run in a shell terminal :
 
 This directory gathers all the code files necessary to compute the mesh-based topology optimization of a periodic grating. Each element of the Finite Element triangulation can have a different permittivity in order to get the best reflection efficiency possible on a particular order for a given wavelength range.
 
-**One should read the paper "Topology optimization of blazed gratings under conical incidence" available on <u>link</u> before using this script.**
+**One should read the paper "Topology optimization of blazed gratings under conical incidence" (S. Ans, G. Demésy, and F. Zamkotsian) available at https://arxiv.org/abs/2403.10174 before using this script.**
 
 ## Quick Start
 
diff --git a/DiffractionGratingsTopOpt/resolution_functions.py b/DiffractionGratingsTopOpt/resolution_functions.py
index 63a274c..3129d58 100644
--- a/DiffractionGratingsTopOpt/resolution_functions.py
+++ b/DiffractionGratingsTopOpt/resolution_functions.py
@@ -5,6 +5,13 @@ import multiprocessing
 import tabs_material
 from config_topopt_conical_data import *
 
+'''
+© Simon Ans
+File : resolution_functions.py
+
+Functions that settle the data and launch the resoutions.
+'''
+
 ##########################################################
 ##             FUNCTIONS USING THE TERMINAL             ##
 ##                  Use Gmsh and GetDP                  ##
diff --git a/DiffractionGratingsTopOpt/topopt_conical.geo b/DiffractionGratingsTopOpt/topopt_conical.geo
index 8cd6ef7..b2a56dc 100644
--- a/DiffractionGratingsTopOpt/topopt_conical.geo
+++ b/DiffractionGratingsTopOpt/topopt_conical.geo
@@ -2,8 +2,8 @@
 © Simon Ans
 File : topopt_conical.geo
 
-Construction of the geometry of the periodical grating made with sticks using
-the data in param.dat. The geometry is detailed in resolution_functions.set_data.
+Construction of the geometry of the periodical mesh-based density grating using
+the data in param.dat. The geometry is detailed in resolution_functions.set_data
 */
 
 Include "param.dat";
diff --git a/DiffractionGratingsTopOpt/topopt_conical.pro b/DiffractionGratingsTopOpt/topopt_conical.pro
index 2f08a8a..a754d8f 100644
--- a/DiffractionGratingsTopOpt/topopt_conical.pro
+++ b/DiffractionGratingsTopOpt/topopt_conical.pro
@@ -1,9 +1,9 @@
 /*
-File : fictiveLamellarGratings_conical.pro
+File : topopt_conical.pro
 
-Strating from the geometry computed by fictiveLamellar_conical.geo, this program
-uses the open source environment GetDP to solve the reflexion and transmission
-problem on the sticks grating.
+Strating from the geometry computed by topopt_conical.geo, this program
+uses the open source environment GetDP to solve the reflection and transmission
+direct and adjoint problems based on a Finite Element mesh generated by Gmsh.
 */
 
 Include "param.dat";
-- 
GitLab