{"id":397669,"date":"2024-12-16T20:49:04","date_gmt":"2024-12-16T20:49:04","guid":{"rendered":"https:\/\/innovationspace.ansys.com\/forum\/forums\/topic\/flexible-material-plugin-issue\/"},"modified":"2024-12-16T20:49:04","modified_gmt":"2024-12-16T20:49:04","slug":"flexible-material-plugin-issue","status":"publish","type":"topic","link":"https:\/\/innovationspace.ansys.com\/forum\/forums\/topic\/flexible-material-plugin-issue\/","title":{"rendered":"Flexible Material Plugin Issue"},"content":{"rendered":"

<div class=”x_elementToProof” data-olk-copy-source=”MessageBody”>Good Afternoon,<\/div><div class=”x_elementToProof”> <\/div><div class=”x_elementToProof”>I am a Post Doc at the University of Toronto in the Department of ECE in the Amr Helmy group.  We have a department Ansys account.  I am looking to adapt a flexible material plugin for Two Photon Absorption (TPA) based on C++ that was originally developed by the following source “Integrated Nanoplasmonic Waveguides and Devices for All-Optical Nanocircuitry” as recommended on a previous Ansys Forum post.  There are 3 files in the appendix of the thesis and I have attached them all.  I understand I need a .dll file in the material plugin folder for this to work in Lumerical.  However none of the 3 files seems to generate a .dll file or us a main{} function in the code which is required in C++.  Is there a “make” file that I need to do this to generate the .dll file?  I am a little confused as to how this work.  Any help would be greatly appreciated.  <\/div><div class=”x_elementToProof”> <\/div><div class=”x_elementToProof”>Best Regards,<\/div><div class=”x_elementToProof”> <\/div><div class=”x_elementToProof”>Jon Atkinson<\/div><div class=”x_elementToProof”> <\/div><div class=”x_elementToProof”>Si_TPA.cpp:<\/strong><\/div><div class=”x_elementToProof”> <\/div><div class=”x_elementToProof”><div>#include “SiTPA.h”<\/div><div>#include <cmath><\/div><div>\/*!<\/div><div>\\class NSiTPAPlugin<\/div><div>For studying TPA and free carrier effects in Si in the telecom wavelengths<\/div><div>around 1.55um.<\/div><div>Based on the FDTD formulism for TPA and free carrier effects from [1].<\/div><div>Does not take into account linear absorption and dispersive refractive<\/div><div>index (assumes you use Si as the base material in Lumerical), and does not<\/div><div>currently have Kerr or Raman effects (since these<\/div><div>occur on a different scale than TPA and free carrier effects). All units are<\/div><div>standard SI.<\/div><div>[1] N. Suzuki, “FD-TD Analysis of Two-Photon Absorption and Free<\/div><div>Carrier Absorption in Si High-Index-Contrast Waveguides,” Journal of Lightwave<\/div><div>Technology 25, 2495 (2007).<\/div><div>*\/<\/div><div>const double SiTPAPlugin::hbar = 1.05457148e-34; \/\/ [J\/s]<\/div><div>const double SiTPAPlugin::exp = 0.8; \/\/constant<\/div><div>const double SiTPAPlugin::eps0 = 8.854187817e-12; \/\/vacuum permitivity [F\/m]<\/div><div>const double SiTPAPlugin::c = 2.99792458e8; \/\/speed of light [m\/s]<\/div><div>const double SiTPAPlugin::tau = 1e-12; \/\/free carrier recombination time in<\/div><div>oxygen doped silicon[s]<\/div><div>const double SiTPAPlugin::n0 = 3.48; \/\/refractive index of Si at 1.55um<\/div><div>const double SiTPAPlugin::betaTPA = 0.9e-11; \/\/ [m\/W]<\/div><div>const double SiTPAPlugin::pi = 3.1415926535897931;<\/div><div>const double SiTPAPlugin::Nfi = 1.01e16; \/\/[m^-3] intrinsic free carrier density<\/div><div>of Si<\/div><div>const char* SiTPAPlugin::names[4] = {“Peak Intensity of Input Pulse [W\/m^2]”,<\/div><div>”Center Wavelength of Input Pulse [m]”,”Initial Free Carrier Concentration [m^- 3]”, 0};<\/div><div>void SiTPAPlugin::initialize(const double** parameters, double dt)<\/div><div>{<\/div><div>d_t=dt;<\/div><div>    for(int i=0; i<3; i++){<\/div><div>Ip[i] = double(parameters[0][i]);<\/div><div>lambda0[i] = float(parameters[1][i]);<\/div><div>N_initial[i] = double(parameters[2][i]);<\/div><div>lambda_n[i]=lambda0[i]\/1.55e-6;<\/div><div>}<\/div><div>}<\/div><div>float SiTPAPlugin::calculate(int i, float U, float V, float Et, float* storage)<\/div><div>{<\/div><div>double Nf = storage[0];<\/div><div>double n_plasma_n = storage[1];<\/div><div>double Vn = storage[2];<\/div><div>double Un = storage[3];<\/div><div>double En = double(Et);<\/div><div>double E = double(Et);<\/div><div>float firstUpdateDone = storage[4];<\/div><div> <\/div><div>n=1.;<\/div><div> <\/div><div>Nf = (2.*tau- d_t)\/(2.*tau+d_t)*Nf+tau*d_t\/(2.*tau+d_t)*lambda0[i]\/2.\/pi\/c\/hbar*betaTPA*Ip[i<\/div><div>]*Ip[i]*abs(En*En*En*En); \/\/free carrier concentration<\/div><div>if (firstUpdateDone == 0.) \/\/initial free carrier concentration<\/div><div>Nf = N_initial[i];<\/div><div>if (Nf<Nfi) \/\/free carrier concentration cannot drop below intrinsic value<\/div><div>for silicon<\/div><div>Nf=Nfi;<\/div><div> <\/div><div>firstUpdateDone = 1.;<\/div><div>n_plasma=-8.8e-28*Nf-8.5e- 24*(pow(Nf,exp))*lambda_n[i]*lambda_n[i]; \/\/change in refractive index due to<\/div><div>plasma dispersion<\/div><div> <\/div><div>\/\/loop for iterating E field and effect of chi_TPA and chi_FCA. 6<\/div><div>iterations was determiend to be sufficient for convergence<\/div><div>while (n<6){<\/div><div>g1=2*n0*n_plasma+c*n0*(1.45e- 21*lambda_n[i]*lambda_n[i]*Nf)*d_t\/2+c*c*eps0*n0*n0*betaTPA*d_t*(E*E+<\/div><div>En*En)*Ip[i]\/8;<\/div><div>g2=2*n0*n_plasma_n-c*n0*(1.45e- 21*lambda_n[i]*lambda_n[i]*Nf)*d_t\/2- c*c*eps0*n0*n0*betaTPA*d_t*(E*E+En*En)*Ip[i]\/8;<\/div><div>E=1\/(g1+U)*(g2*En+(V-Vn)+Un*En);<\/div><div>n=n+1;<\/div><div>}<\/div><div> <\/div><div>\/\/update storage<\/div><div>storage[0] = Nf;<\/div><div>storage[1] = n_plasma;<\/div><div>storage[2] = V;<\/div><div>storage[3] = U;<\/div><div>storage[4] = float(firstUpdateDone);<\/div><div> <\/div><div>     return E;<\/div><div>}<\/div><div>float SiTPAPlugin::calculateEx( float U, float V, float Ex, float* storage )<\/div><div>{<\/div><div>return calculate(0, U, V, Ex, storage);<\/div><div>}<\/div><div>float SiTPAPlugin::calculateEy( float U, float V, float Ey, float* storage )<\/div><div>{<\/div><div>return calculate(1, U, V, Ey, storage);<\/div><div>}<\/div><div>float SiTPAPlugin::calculateEz( float U, float V, float Ez, float* storage )<\/div><div>{<\/div><div>return calculate(2, U, V, Ez, storage);<\/div><div>}<\/div><div>MATERIAL_PLUGIN(SiTPAPlugin);<\/div><div> <\/div><div>Si_TPA.h:<\/strong><\/div><div> <\/div><div><div>#ifndef _SITPA_H<\/div><div>#define _SITPA_H<\/div><div> <\/div><div>#include “imaterialplugin.h”<\/div><div> <\/div><div>class SiTPAPlugin : public IMaterialPlugin<\/div><div>{<\/div><div>public:<\/div><div>SiTPAPlugin(){};<\/div><div>virtual ~SiTPAPlugin(){};<\/div><div> <\/div><div>const char* name() const {return “SiTPA”;};<\/div><div>const char* uniqueId() const {return “{CFE9991C-6837-46a2-BBB4- E9EABD833DFC}”;};<\/div><div>const char** parameterNames() const {return names;};<\/div><div>float calculateEx( float U, float V, float Ex, float* storage);<\/div><div>float calculateEy( float U, float V, float Ey, float* storage);<\/div><div>float calculateEz( float U, float V, float Ez, float* storage);<\/div><div>void initialize(const double** parameters, double dt);<\/div><div>void initializeStorageEx(float* storage){};<\/div><div>void initializeStorageEy(float* storage){};<\/div><div>void initializeStorageEz(float* storage){};<\/div><div>size_t storageSizeE() const {return 5;}; \/\/# of additional storage fields<\/div><div> <\/div><div>private:<\/div><div>float calculate(int axis, float U, float V, float E, float* storage);<\/div><div>void initializeStorageE(int axis, float* storage);<\/div><div> <\/div><div>static const double hbar;<\/div><div>static const double eps0;<\/div><div>static const double tau;<\/div><div>static const double betaTPA;<\/div><div>static const double n0;<\/div><div>static const double exp;<\/div><div>static const double c;<\/div><div>static const double pi;<\/div><div>static const double Nfi;<\/div><div> <\/div><div>double Ip[3];<\/div><div>double N_initial[3];<\/div><div>double lambda0[3];<\/div><div>double Nf[3];<\/div><div>double g1;<\/div><div>double g2;<\/div><div>double n_plasma;<\/div><div>double n_plasma_n;<\/div><div>double d_t;<\/div><div>float n;<\/div><div>float lambda_n[3];<\/div><div> <\/div><div>static const char* names[4];<\/div><div>};<\/div><div> <\/div><div>#endif<\/div><div> <\/div><div>immaterialplugin:<\/strong><\/div><div> <\/div><div><div>#ifndef _IMATERIALPLUGIN_H<\/div><div>#define _IMATERIALPLUGIN_H<\/div><div> <\/div><div>#include <stddef.h><\/div><div> <\/div><div>\/*!<\/div><div>\\brief The interface class definition for a material plugin for FDTD Solutions<\/div><div> <\/div><div>This pure abstract class defines the methods that must be implemented to create<\/div><div>a plugin material in FDTD Solutions. A class that inherits from this interface class<\/div><div>and implements all the methods can be compiled into a dynamic library that can<\/div><div>be loaded into FDTD Solutions to define new materials.<\/div><div>*\/<\/div><div> <\/div><div>class IMaterialPlugin<\/div><div>{<\/div><div>public:<\/div><div>virtual ~IMaterialPlugin(){};<\/div><div>virtual const char* name() const = 0;<\/div><div>virtual const char* uniqueId() const = 0;<\/div><div>virtual const char** parameterNames() const = 0;<\/div><div>virtual float calculateEx( float U, float V, float Ex, float* storage) = 0;<\/div><div>virtual float calculateEy( float U, float V, float Ey, float* storage) = 0;<\/div><div>virtual float calculateEz( float U, float V, float Ez, float* storage) = 0;<\/div><div>virtual void initialize(const double** parameters, double dt) = 0;<\/div><div>virtual void initializeStorageEx(float* storage) = 0;<\/div><div>virtual void initializeStorageEy(float* storage) = 0;<\/div><div>virtual void initializeStorageEz(float* storage) = 0;<\/div><div>virtual size_t storageSizeE() const = 0;<\/div><div>};<\/div><div> <\/div><div>\/*!<\/div><div>\\brief The interface class for a magnetic material plugin<\/div><div>This extends the material plugin defined above with a few more methods that<\/div><div>need to be<\/div><div>defined for a magnetic material<\/div><div>*\/<\/div><div>class IMagneticMaterialPlugin : public IMaterialPlugin<\/div><div>{<\/div><div>public:<\/div><div>virtual float calculateHx( float U, float V, float Ex, float* storage) = 0;<\/div><div>virtual float calculateHy( float U, float V, float Ey, float* storage) = 0;<\/div><div>virtual float calculateHz( float U, float V, float Ez, float* storage) = 0;<\/div><div>virtual void initializeStorageHx(float* storage) = 0;<\/div><div>virtual void initializeStorageHy(float* storage) = 0;<\/div><div>virtual void initializeStorageHz(float* storage) = 0;<\/div><div>virtual size_t storageSizeH() const = 0;<\/div><div>};<\/div><div> <\/div><div>\/*!<\/div><div>\\brief The interface for a factory class that creates and destroys material plugins<\/div><div>*\/<\/div><div>class IMaterialPluginFactory{<\/div><div>public:<\/div><div>virtual IMaterialPlugin* createInstance()=0;<\/div><div>virtual void destroyInstance(IMaterialPlugin* i)=0;<\/div><div>virtual IMagneticMaterialPlugin* toMagneticMaterialPlugin(IMaterialPlugin*p)=0;<\/div><div>};<\/div><div> <\/div><div>\/*!<\/div><div>\\brief A templated implementation of the IMaterialPluginFactory class<\/div><div> <\/div><div>Plugin authors do not need to write a factory class, they can just use this class.<\/div><div>It is written<\/div><div>as a template so that it can be compiled into the plugin easily. This is done in<\/div><div>the plugin code<\/div><div>usign the MATERIAL_PLUGIN(T) macro.<\/div><div>*\/<\/div><div>template<class T><\/div><div>class MaterialPluginFactory : public IMaterialPluginFactory<\/div><div>{<\/div><div>IMaterialPlugin* createInstance(){return new T();}<\/div><div>void destroyInstance(IMaterialPlugin* i){delete i;}<\/div><div>IMagneticMaterialPlugin* toMagneticMaterialPlugin(IMaterialPlugin*<\/div><div>p){return dynamic_cast<IMagneticMaterialPlugin*>(p);}<\/div><div>};<\/div><div> <\/div><div>#ifdef WIN32<\/div><div>#define DLLEXPORT __declspec(dllexport)<\/div><div>#else<\/div><div>#define DLLEXPORT<\/div><div>#endif<\/div><div> <\/div><div>\/\/A macro to add the factory function to the plugin, instantiating the<\/div><div>MaterialPluginFactory in the process<\/div><div>\/\/All plugins should include this macro once in a source file. The argument T is<\/div><div>the name of the user’s plugin class<\/div><div>#define MATERIAL_PLUGIN(T) \\<\/div><div>   extern “C” DLLEXPORT IMaterialPluginFactory* createFactoryV1(){ return<\/div><div>new MaterialPluginFactory<T>();} \\<\/div><div>   extern “C” DLLEXPORT void destroyFactoryV1(IMaterialPluginFactory* f){<\/div><div>delete f;}<\/div><div> <\/div><div>#endif<\/div><\/div><div> <\/div><\/div><\/div><\/p>\n","protected":false},"template":"","class_list":["post-397669","topic","type-topic","status-publish","hentry"],"aioseo_notices":[],"acf":[],"custom_fields":[{"0":{"_bbp_forum_id":["27833"],"_bbp_topic_id":["397669"],"_bbp_subscription":["10770","14496","465406"],"_bbp_author_ip":["142.150.242.144"],"_bbp_last_reply_id":["405344"],"_bbp_last_active_id":["405344"],"_bbp_last_active_time":["2025-01-17 03:30:45"],"_bbp_reply_count":["5"],"_bbp_reply_count_hidden":["0"],"_bbp_voice_count":["3"],"_bbp_engagement":["10770","14496","465406"],"_btv_view_count":["178"],"_bbp_topic_status":["unanswered"]},"test":"jonathan-atkinsonutoronto-ca"}],"_links":{"self":[{"href":"https:\/\/innovationspace.ansys.com\/forum\/wp-json\/wp\/v2\/topics\/397669","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/innovationspace.ansys.com\/forum\/wp-json\/wp\/v2\/topics"}],"about":[{"href":"https:\/\/innovationspace.ansys.com\/forum\/wp-json\/wp\/v2\/types\/topic"}],"version-history":[{"count":0,"href":"https:\/\/innovationspace.ansys.com\/forum\/wp-json\/wp\/v2\/topics\/397669\/revisions"}],"wp:attachment":[{"href":"https:\/\/innovationspace.ansys.com\/forum\/wp-json\/wp\/v2\/media?parent=397669"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}