{"id":1667,"date":"2016-08-30T10:33:11","date_gmt":"2016-08-30T17:33:11","guid":{"rendered":"https:\/\/live-optics-wp.pantheonsite.io\/milster\/?page_id=1667"},"modified":"2016-09-19T10:00:17","modified_gmt":"2016-09-19T17:00:17","slug":"custom-mathematical-operations","status":"publish","type":"page","link":"https:\/\/wp.optics.arizona.edu\/milster\/resources\/optiscan-simulation-program\/optiscan-help-desk\/index\/custom-mathematical-operations\/","title":{"rendered":"Custom Mathematical Operations"},"content":{"rendered":"

Allows the user to augment the functionality of OPTISCAN through use of custom mathematical electric field calculations.<\/p>\n

Overview:<\/h3>\n

In order to use a Custom Mathematical Operation object, you need to create an m-file which uses the following function declaration formation:<\/p>\n

function<\/strong> [mop, curlink, simdata, errmsg] = function_name<\/em>(action, mop curlink, simdata);<\/pre>\n
if the function call is successful, the the function should set the output variable as follows:<\/p>\n
errmsg<\/em> = ”;<\/p>\n
if the function call is not successful, and therefore the simulation should be stopped, then\u00a0errmsg<\/em> should be set equal to a description of the error that occurred:<\/p>\n
errmsg<\/em> = ‘The Input Field Cannot be Zero’;<\/p>\n
Sometimes it is important for the mathematical operation to know what kind of input link is connected to it. This can be done by querying curlink for its linktype :<\/p>\n
if istransmitted<\/em>(curlink)\r\n %the input linktype is transmitted\r\n elseif isreflected<\/em>(curlink)\r\n %the input linktype is reflected\r\n else\r\n %an electric field is not explicitly being transmitted to\r\n %the MOP object.\r\n end<\/pre>\n
For the following configuration:<\/p>\n
\"source-to-MOP\"<\/p>\n
the istransmitted<\/em>(curlink) function would return “true” since the input link is propagating transmitted electric fields to the MOP object. The electric fields can be retrieved through the simdata variable:<\/p>\n
transmitted fields <\/strong><\/p>\n
Ext = simdata.Ext
\nEyt = simdata.Eyt
\nEzt = simdata.Ezt<\/p>\n
reflected fields <\/strong><\/p>\n
Exr = simdata.Exr
\nEyt = simdata.Eyr
\nEzt = simdata.Ezr<\/p>\n
The ordinate and abcissa vectors can be similarly queried using:<\/p>\n
sysxvec = simdata.sysxvec; %x-positions of each column
\nsysyvec = simdata.sysyvec; %y-positions of each row<\/p>\n
After the function is finished modifying the fields and\/or the ordinate and abcissa vectors, it needs to update the simdata variable using:<\/p>\n
simdate.Ext = Ext;
\nsimdata.Eyt = Eyt;
\netc….<\/p>\n
\n
The MOP function may wish to save some information between invocations. The simdata variable allows the function to retrieve the custom “user data” that is associated with a specific MOP object by using:<\/p>\n
userdata = simdata.userdata<\/p>\n
if isempty(userdata)\r\n %need to initialize the userdata\r\n userdata.sinvector = sin( linspace(0,2*pi,100);\r\n userdata.cosvector = cos( linspace(0,2*pi,100);\r\n end<\/pre>\n
After the custom “user data” is initialized and\/or updated, it can be stored by using:<\/p>\n
simdata.userdata = userdata;<\/p>\n
\n
The following is a list of other simdata properties that may be useful:<\/p>\n