GSvit documentation

open source FDTD solver with GPU support

User Tools

Site Tools


docs:gsvit_inputs

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
docs:gsvit_inputs [2018/06/30 00:26]
pklapetek
docs:gsvit_inputs [2023/08/06 15:05] (current)
pklapetek
Line 301: Line 301:
  
 <​b>​Medium modifiers</​b>​ <​b>​Medium modifiers</​b>​
- 
-<​p><​b>​MEDIUM_ROUGHEN</​b><​br>​ 
-<​i>​radius_peak radius_span iterations probability material_index void_index random_seed</​i><​br>​ 
-Adds roughness to objects consisting of defined tabulated material (parameter material_index) adding this 
-material and void or any other material (parameter void_index) to the object randomly. 
-Roughness is controlled by parameter radius_peak and radius_span (both in voxel coordinates) that 
-control radius and dispersion of spheres that are added. Parameter probability controls amount of spheres 
-added in every point. Random seed can be any integer to get same result or -1 to generate seed automatically. 
-Note that materials (parameter material index) are counted from 1 as they are loaded from vector material 
-file (so the first material listed there has index of 1). Material with index=0 is vacuum by default 
-As an example, to add roughness to a sphere (the only object in material file), using 20 iterations 
-of adding and removing spheres of radius 5+-2 voxels, add this: 
-<​tt><​br><​br>​ 
-MEDIUM_ROUGHEN<​br>​ 
-5 2 20 0.01 1 0 1<br> 
-</tt> 
-</p> 
-<​p><​i>​Note that this option is not supported for direct editing by XSvit in this version</​i></​p>​ 
  
 <​p><​b>​MEDIUM_GROW</​b><​br>​ <​p><​b>​MEDIUM_GROW</​b><​br>​
Line 342: Line 324:
 </p> </p>
 <​p><​i>​Note that this option is not supported for direct editing by XSvit in this version</​i></​p>​ <​p><​i>​Note that this option is not supported for direct editing by XSvit in this version</​i></​p>​
 +
 +<​p><​b>​MEDIUM_ROUGHEN</​b><​br>​
 +<​i>​radius_peak radius_span iterations probability material_index void_index random_seed</​i><​br>​
 +Adds roughness to objects consisting of defined tabulated material (parameter material_index) adding this
 +material and void or any other material (parameter void_index) to the object randomly.
 +Roughness is controlled by parameter radius_peak and radius_span (both in voxel coordinates) that
 +control radius and dispersion of spheres that are added. Parameter probability controls amount of spheres
 +added in every point. Random seed can be any integer to get same result or -1 to generate seed automatically.
 +Note that materials (parameter material index) are counted from 1 as they are loaded from vector material
 +file (so the first material listed there has index of 1). Material with index=0 is vacuum by default
 +As an example, to add roughness to a sphere (the only object in material file), using 20 iterations
 +of adding and removing spheres of radius 5+-2 voxels, add this:
 +<​tt><​br><​br>​
 +MEDIUM_ROUGHEN<​br>​
 +5 2 20 0.01 1 0 1<br>
 +</tt>
 +</p>
 +<​p><​i>​Note that this option is not supported for direct editing by XSvit in this version</​i></​p>​
 +
 +<​p><​b>​MEDIUM_SPECTRAL</​b><​br>​
 +<​i>​sigma T material_index random_seed</​i><​br>​
 +Adds roughness to objects consisting of all tabulated materials (parameter material_index is only reserved for future use) using spectral synthesis and vector displacement method. Roughness parameters sigma and T controlling variance and correlation length are given in voxels.
 +Random seed can be -1 to get it randomly.
 +
 +<​p><​b>​MEDIUM_EXPRESSION</​b><​br>​
 +<​i>​i_start j_start k_start i_end j_end k_end material_index void_index max_distance distance_mode expression</​i><​br>​
 +Alters object boundary using some analytical expression. In the expression, x, y and z mean the voxel coordinates. Basic mathematical functions and constants (pi) can be used.
 +As an example, this combination of sine functions can create quite chaotic surface shape:
 +<​tt><​br><​br>​
 +MEDIUM_EXPRESSION<​br>​
 +10 10 10 290 290 290 1 0 10 1 0.5+0.08*sin(x/​2)+0.08*sin(y/​3)+0.08*sin(z/​3.8)+0.08*sin((x+y)/​5)+0.08*sin((y+z)/​2.5)+0.08*sin((x+z)/​4.2)<​br>​
 +</tt>
 +
  
 <​br><​br>​ <​br><​br>​
Line 402: Line 417:
 <​i>​boundary</​i><​br>​ <​i>​boundary</​i><​br>​
 Specifies boundary that should be excluded from TSF application. Parameter "​boundary"​ Specifies boundary that should be excluded from TSF application. Parameter "​boundary"​
-is string denoting which boundary is being set (i0, j0, k0, in, jn, kn). Note that+is string denoting which boundary is being set (i0, j0, k0, in, jn, kn, depth N). Note that
 in principle TSF should be applied on all the boundaries to work properly, but in case in principle TSF should be applied on all the boundaries to work properly, but in case
 of special materials or boundary conditions some boundary skipping can make sense. of special materials or boundary conditions some boundary skipping can make sense.
 +The special boundary setting "​depth"​ followed by a positive integer number, e.g. "depth 5"
 +causes solver to skip the TSF application in all the places with some material (not vacuum)
 +and even some number of voxels (parameter depth) close to it. This is useful to remove only some area where material is traversing the TSF boundary from the TSF application.
 </p> </p>
  
Line 480: Line 498:
 parameter "​mode"​ is therefore followed by wavelength and by gaussian envelope width, parameter "​mode"​ is therefore followed by wavelength and by gaussian envelope width,
 given in integer steps of the simulation (e.g. 20), and finally electric field amplitude. given in integer steps of the simulation (e.g. 20), and finally electric field amplitude.
 +</p>
 +
 +
 +<​p><​b>​TSFF_EXPORT</​b><​br>​
 +<​i>​filebase_e filebase_h</​i><​br>​
 +Saves the calculated focused source boundary data for further use by SOURCE_TSFF_EXT. Only top z plane is used. Files contain both ex, ey and hx, hy components, for each step one file is created.
 +</p>
 +
 +<​p><​b>​SOURCE_TSFF_EXT</​b><​br>​
 +<​i>​i_start j_start k_start i_end j_end k_end filebase_e filebase_h</​i><​br>​
 +Uses pre-calculated focused source boundary data as a source. Only top z plane is used. Settings should be same as in SOURCE_TSFF_EXPORT.
 </p> </p>
  
Line 530: Line 559:
  
 <​p><​b>​OUT_IMAGE</​b><​br>​ <​p><​b>​OUT_IMAGE</​b><​br>​
-<​i>​Ex/​Ey/​Ez/​Hx/​Hy/​Hz/​All/​Epsilon/​Sigma/​Mu/​Sigast nskip  i j k description</​i><​br>​+<​i>​Ex/​Ey/​Ez/​Hx/​Hy/​Hz/​All/​Epsilon/​Sigma/​Mu/​Sigast/​Material ​nskip  i j k description</​i><​br>​
 Output image of plane cross-section. Which plane is used is determined Output image of plane cross-section. Which plane is used is determined
 by indices i j k; two of them must be -1. All results are saved to a .gwy file, skipping given by indices i j k; two of them must be -1. All results are saved to a .gwy file, skipping given
docs/gsvit_inputs.1530311216.txt.gz ยท Last modified: 2018/06/30 00:26 by pklapetek