Added the ability to use structures with input parameters for the FDT…

…D GUI

CHANGELOG

@@ -4,6 +4,9 @@ Todo:
 - Tangent vectors managements for Selene
 - Implement the Lambertian, Guassian and ABg scattering models ( see "What scattering models are available in OpticStudio?" )
 
+0.12
+- The FDTD GUI can now load structures that have parameters
+
 0.11.1
 - Fixed materials loading in CLI FDTD
 - Fixed the use of the output directory for sensors in GUI FDTD

src/GUI/FDTD/gui_fdtd.cpp

@@ -774,9 +774,24 @@ void FDTD_Frame::reconstruct_tree()
     if(!fdtd_parameters.structure->script.empty())
         tree->AppendItem(structure_ID,fdtd_parameters.structure->script.generic_string());
     else tree->AppendItem(structure_ID,"None");
-    tree->AppendItem(structure_ID,"Dx="+add_unit(fdtd_parameters.Dx));
-    tree->AppendItem(structure_ID,"Dy="+add_unit(fdtd_parameters.Dy));
-    tree->AppendItem(structure_ID,"Dz="+add_unit(fdtd_parameters.Dz));
+    tree->AppendItem(structure_ID,"Dx= "+add_unit(fdtd_parameters.Dx));
+    tree->AppendItem(structure_ID,"Dy= "+add_unit(fdtd_parameters.Dy));
+    tree->AppendItem(structure_ID,"Dz= "+add_unit(fdtd_parameters.Dz));
+
+    if(!fdtd_parameters.structure->parameter_name.empty())
+    {
+        wxTreeItemId tmp=tree->AppendItem(structure_ID,"Parameters");
+
+        for(std::size_t i=0;i<fdtd_parameters.structure->parameter_name.size();i++)
+        {
+            std::stringstream strm;
+
+            strm<<fdtd_parameters.structure->parameter_name[i]<<"= ";
+            strm<<fdtd_parameters.structure->parameter_value[i];
+
+            tree->AppendItem(tmp,strm.str());
+        }
+    }
 
     // Incidence
 
@@ -935,8 +950,8 @@ void FDTD_Frame::save(wxFileName const &fname)
     structure_path=to_relative_file(p.structure->script,save_path);
 
     file<<"structure=Structure(\""<<structure_path.generic_string()<<"\")\n";
-    for(std::size_t i=0;i<p.structure->user_parameter_name.size();i++)
-        file<<"structure:parameter(\""<<p.structure->user_parameter_name[i]<<"\","<<p.structure->user_parameter_value[i]<<")\n";
+    for(std::size_t i=0;i<p.structure->parameter_name.size();i++)
+        file<<"structure:parameter(\""<<p.structure->parameter_name[i]<<"\","<<p.structure->parameter_value[i]<<")\n";
     file<<"\n";
 
          if(type==FDTD_Mode::FDTD_CUSTOM) file<<"fdtd=MODE(\"fdtd\")\n";

src/GUI/FDTD/gui_fdtd.h

@@ -96,9 +96,14 @@ class FDTD_Mode_Dialog: public wxDialog
         NamedTextCtrl<int> *Nt_points;
 
         // Structure
+        wxScrolledWindow *structure_panel;
         NamedTextCtrl<std::string> *structure;
         wxButton *structure_edit_btn;
-        NamedTextCtrl<double> *dx_ctrl,*dy_ctrl,*dz_ctrl;
+        LengthSelector *dx_ctrl,*dy_ctrl,*dz_ctrl;
+        wxPanel *parameters_panel;
+        wxStaticBoxSizer *parameters_sizer;
+        std::vector<NamedTextCtrl<double>*> parameters;
+        std::vector<std::string> parameter_names;
 
         // Incidence
         wxChoice *polarization;
@@ -129,6 +134,7 @@ class FDTD_Mode_Dialog: public wxDialog
         void evt_edit_structure(wxCommandEvent &event);
         void evt_load_structure(wxCommandEvent &event);
         void evt_material_change(wxCommandEvent &event);
+        void evt_structure_parameter(wxCommandEvent &event);
         void evt_ok(wxCommandEvent &event);
         void evt_output_directory(wxCommandEvent &event);
         void evt_time(wxCommandEvent &event);

src/GUI/FDTD/gui_fdtd_mode_dialog.cpp

@@ -513,7 +513,7 @@ void FDTD_Mode_Dialog::FDTD_Mode_Dialog_Materials(wxNotebook *book,int target_pa
 
 void FDTD_Mode_Dialog::FDTD_Mode_Dialog_Structure(wxNotebook *book,int target_panel)
 {
-    wxPanel *structure_panel=new wxPanel(book);
+    structure_panel=new wxScrolledWindow(book);
     wxBoxSizer *structure_sizer=new wxBoxSizer(wxVERTICAL);
 
     // - Script
@@ -537,20 +537,58 @@ void FDTD_Mode_Dialog::FDTD_Mode_Dialog_Structure(wxNotebook *book,int target_pa
 
     // - Discretization
 
+    wxBoxSizer *bottom_sizer=new wxBoxSizer(wxHORIZONTAL);
+
     wxStaticBoxSizer *structure_discr_sizer=new wxStaticBoxSizer(wxVERTICAL,structure_panel,"Discretization");
-    dx_ctrl=new NamedTextCtrl<double>(structure_discr_sizer->GetStaticBox(),"Dx: ",data->Dx);
-    dy_ctrl=new NamedTextCtrl<double>(structure_discr_sizer->GetStaticBox(),"Dy: ",data->Dy);
-    dz_ctrl=new NamedTextCtrl<double>(structure_discr_sizer->GetStaticBox(),"Dz: ",data->Dz);
+    dx_ctrl=new LengthSelector(structure_discr_sizer->GetStaticBox(),"Dx: ",data->Dx);
+    dy_ctrl=new LengthSelector(structure_discr_sizer->GetStaticBox(),"Dy: ",data->Dy);
+    dz_ctrl=new LengthSelector(structure_discr_sizer->GetStaticBox(),"Dz: ",data->Dz);
+
+    dx_ctrl->Bind(EVT_LENGTH_SELECTOR,&FDTD_Mode_Dialog::evt_structure_parameter,this);
+    dy_ctrl->Bind(EVT_LENGTH_SELECTOR,&FDTD_Mode_Dialog::evt_structure_parameter,this);
+    dz_ctrl->Bind(EVT_LENGTH_SELECTOR,&FDTD_Mode_Dialog::evt_structure_parameter,this);
 
     structure_discr_sizer->Add(dx_ctrl,wxSizerFlags().Expand());
     structure_discr_sizer->Add(dy_ctrl,wxSizerFlags().Expand());
     structure_discr_sizer->Add(dz_ctrl,wxSizerFlags().Expand());
 
-    structure_sizer->Add(structure_discr_sizer);
+    bottom_sizer->Add(structure_discr_sizer);
+
+    // - Parameters
+
+    parameters_panel=new wxPanel(structure_panel);
+    parameters_sizer=new wxStaticBoxSizer(wxVERTICAL,parameters_panel,"Parameters");
+
+    if(data->structure->script.empty())
+    {
+        parameters_panel->Hide();
+    }
+    else
+    {
+        data->structure->finalize();
+        parameter_names=data->structure->parameter_name;
+
+        for(std::size_t i=0;i<data->structure->parameter_name.size();i++)
+        {
+            NamedTextCtrl<double> *param=new NamedTextCtrl(parameters_sizer->GetStaticBox(),
+                                                           data->structure->parameter_name[i]+" : ",
+                                                           data->structure->parameter_value[i]);
+            param->Bind(EVT_NAMEDTXTCTRL,&FDTD_Mode_Dialog::evt_structure_parameter,this);
+
+            parameters.push_back(param);
+            parameters_sizer->Add(param,wxSizerFlags().Expand());
+        }
+    }
+
+    parameters_panel->SetSizer(parameters_sizer);
+    bottom_sizer->Add(parameters_panel);
+
+    structure_sizer->Add(bottom_sizer);
 
     structure_panel->SetSizer(structure_sizer);
     book->AddPage(structure_panel,"Structure");
 
+
     if(target_panel==1) book->SetSelection(N_panels); N_panels++;
 }
 
@@ -608,9 +646,42 @@ void FDTD_Mode_Dialog::evt_load_structure(wxCommandEvent &event)
     std::filesystem::path struct_path=structure->get_value();
     struct_path=std::filesystem::absolute(struct_path);
 
+    // Cleanup
+
+    for(NamedTextCtrl<double> *param : parameters)
+        param->Destroy();
+
+    parameters.clear();
+
+    // Loading the new parameters
+
     Structure loader(struct_path);
     loader.finalize();
 
+    parameter_names=loader.parameter_name;
+
+    for(std::size_t i=0;i<loader.parameter_name.size();i++)
+    {
+        NamedTextCtrl<double> *param=new NamedTextCtrl(parameters_sizer->GetStaticBox(),
+                                                       loader.parameter_name[i]+" : ",
+                                                       loader.parameter_value[i]);
+        param->Bind(EVT_NAMEDTXTCTRL,&FDTD_Mode_Dialog::evt_structure_parameter,this);
+
+        parameters.push_back(param);
+        parameters_sizer->Add(param,wxSizerFlags().Expand());
+    }
+
+    if(loader.parameter_name.empty())
+    {
+        parameters_panel->Hide();
+    }
+    else
+    {
+        parameters_panel->Show();
+    }
+
+    structure_panel->FitInside();
+
     event.Skip();
 }
 
@@ -623,6 +694,13 @@ void FDTD_Mode_Dialog::evt_material_change(wxCommandEvent &event)
     event.Skip();
 }
 
+
+void FDTD_Mode_Dialog::evt_structure_parameter(wxCommandEvent &event)
+{
+    new_structure=true;
+}
+
+
 void FDTD_Mode_Dialog::evt_ok(wxCommandEvent &event)
 {
     // Main
@@ -673,16 +751,14 @@ void FDTD_Mode_Dialog::evt_ok(wxCommandEvent &event)
     // Structure
     data->structure->script=structure->get_value();
     data->structure->script=std::filesystem::absolute(data->structure->script);
+
+    data->structure->parameter_name.clear();
+    data->structure->parameter_value.clear();
 
-    if(data->Dx!=dx_ctrl->get_value() ||
-       data->Dy!=dy_ctrl->get_value() ||
-       data->Dz!=dz_ctrl->get_value() )
+    for(std::size_t i=0;i<parameters.size();i++)
     {
-        data->Dx=dx_ctrl->get_value();
-        data->Dy=dy_ctrl->get_value();
-        data->Dz=dz_ctrl->get_value();
-
-        new_structure=true;
+        data->structure->parameter_name.push_back(parameter_names[i]);
+        data->structure->parameter_value.push_back(parameters[i]->get_value());
     }
 
     // Materials

src/structure/lua_structure.cpp

@@ -268,13 +268,13 @@ int structure_set_parameter(lua_State *L)
     double parameter_value=lua_tonumber(L,3);
 
     bool found=false;
-    std::size_t k=vector_locate(found,p_struct->user_parameter_name,parameter_name);
+    std::size_t k=vector_locate(found,p_struct->parameter_name,parameter_name);
 
-    if(found) p_struct->user_parameter_value[k]=parameter_value;
+    if(found) p_struct->parameter_value[k]=parameter_value;
     else
     {
-        p_struct->user_parameter_name.push_back(parameter_name);
-        p_struct->user_parameter_value.push_back(parameter_value);
+        p_struct->parameter_name.push_back(parameter_name);
+        p_struct->parameter_value.push_back(parameter_value);
     }
 
     return 0;
@@ -604,20 +604,19 @@ int structure_declare_parameter(lua_State *L)
 
     // Locating in the script parameters
 
-    std::size_t k=vector_locate(found,p_struct->script_parameter_name,parameter_name);
+    std::size_t k=vector_locate(found,p_struct->parameter_name,parameter_name);
 
-    if(found) p_struct->script_parameter_value[k]=parameter_default_value;
-    else
+    if(!found)
     {
-        p_struct->script_parameter_name.push_back(parameter_name);
-        p_struct->script_parameter_value.push_back(parameter_default_value);
+        p_struct->parameter_name.push_back(parameter_name);
+        p_struct->parameter_value.push_back(parameter_default_value);
     }
 
     // Locating in the input parameters
 
-    k=vector_locate(found,p_struct->user_parameter_name,parameter_name);
+    k=vector_locate(found,p_struct->parameter_name,parameter_name);
 
-    if(found) lua_pushnumber(L,p_struct->user_parameter_value[k]);
+    if(found) lua_pushnumber(L,p_struct->parameter_value[k]);
     else lua_pushnumber(L,parameter_default_value);
 
     lua_setglobal(L,parameter_name.c_str());

src/structure/structure.cpp

@@ -97,8 +97,6 @@ void Structure::finalize()
     for(std::size_t i=0;i<operations.size();i++)
         delete operations[i];
 
-    script_parameter_name.clear();
-    script_parameter_value.clear();
     operations.clear();
 
     if(script.empty()) return;

src/structure/structure.h

@@ -214,11 +214,8 @@ class Structure
         lua_State *L;
         std::filesystem::path script;
 
-        std::vector<double> user_parameter_value,
-                            script_parameter_value;
-
-        std::vector<std::string> user_parameter_name,
-                                 script_parameter_name;
+        std::vector<double> parameter_value;
+        std::vector<std::string> parameter_name;
 
         std::vector<Structure_OP*> operations;