FLOOXS » Commands » field

field — Commands

11 command(s) registered from src/field/.

anicubic · fftmesh · fs · isocontour · locationspacingpairs · meshvoxel · mirror · pointcloud · refine · simplex · tetgenopts

anicubic

module: field · source: src/field/AniCubicCmd.cc

Option Type Default Description
field String name of the RealField to interpolate
x Float 0.000000e+00 query x coordinate
y Float 0.000000e+00 query y coordinate
z Float 0.000000e+00 query z coordinate
oob Switch out-of-range behavior (default: error)
error Boolean 0 TCL_ERROR if the query falls outside the mesh
clamp Boolean 0 clip the query to the mesh extent before interpolating
extrapolate Boolean 0 extend the boundary cubic past the mesh edge
Raw -help output
anicubic
Length Scale Default is microns which can be changed with the option command
Name            Type     Default               Information
field           String                        name of the RealField to interpolate
x               Float    0.000000e+00         query x coordinate
y               Float    0.000000e+00         query y coordinate
z               Float    0.000000e+00         query z coordinate
oob             Switch                        out-of-range behavior (default: error)
	error           Boolean  0                    TCL_ERROR if the query falls outside the mesh
	clamp           Boolean  0                    clip the query to the mesh extent before interpolating
	extrapolate     Boolean  0                    extend the boundary cubic past the mesh edge

fftmesh

module: field · source: src/field/FFTMesh.cc

Option Type Default Description
mater Switch material specification
Gas Boolean 0 a material
gas Boolean 0 a material
SiO2 Boolean 0 a material
sio2 Boolean 0 a material
Oxide Boolean 0 a material
oxide Boolean 0 a material
SpOx Boolean 0 a material
GateOx Boolean 0 a material
HfO2 Boolean 0 a material
hfo2 Boolean 0 a material
Si3N4 Boolean 0 a material
si3n4 Boolean 0 a material
Nitride Boolean 0 a material
nitride Boolean 0 a material
Silicon Boolean 0 a material
silicon Boolean 0 a material
Si Boolean 0 a material
Germanium Boolean 0 a material
Germanium Boolean 0 a material
Ge Boolean 0 a material
SiGe Boolean 0 a material
sige Boolean 0 a material
SiliconGermaniu Boolean 0 a material
SiliconGe Boolean 0 a material
SiGermanium Boolean 0 a material
4HSiC Boolean 0 a material
4hsic Boolean 0 a material
6HSiC Boolean 0 a material
6hsic Boolean 0 a material
3CSiC Boolean 0 a material
3csic Boolean 0 a material
GaN Boolean 0 a material
gan Boolean 0 a material
AlGaN Boolean 0 a material
algan Boolean 0 a material
AlN Boolean 0 a material
aln Boolean 0 a material
Polysilicon Boolean 0 a material
poly Boolean 0 a material
Poly Boolean 0 a material
polySilicon Boolean 0 a material
PolySilicon Boolean 0 a material
polySi Boolean 0 a material
PolySi Boolean 0 a material
Polysi Boolean 0 a material
Oxynitride Boolean 0 a material
oxynitride Boolean 0 a material
Photoresist Boolean 0 a material
PR Boolean 0 a material
pr Boolean 0 a material
photoresist Boolean 0 a material
Metal Boolean 0 a material
metal Boolean 0 a material
Niobium Boolean 0 a material
Nb Boolean 0 a material
niobium Boolean 0 a material
niob Boolean 0 a material
NiobiumOxide Boolean 0 a material
NbOx Boolean 0 a material
nioboxide Boolean 0 a material
niobOxide Boolean 0 a material
niobiumOxide Boolean 0 a material
niobiumoxide Boolean 0 a material
Aluminum Boolean 0 a material
Al Boolean 0 a material
Alum Boolean 0 a material
alum Boolean 0 a material
aluminum Boolean 0 a material
AluminumOxide Boolean 0 a material
AlOx Boolean 0 a material
alumoxide Boolean 0 a material
alumOxide Boolean 0 a material
aluminumOxide Boolean 0 a material
aluminumoxide Boolean 0 a material
semi Boolean 0 a material
Invisible Boolean 0 a material
Insulator Boolean 0 a material
inverse Boolean 0 do inverse fft
nx Int 101 number of x points
ny Int 101 number of y points
nz Int 101 number of z points
data String Tcl list of data fields
Raw -help output
fftmesh
Length Scale Default is microns which can be changed with the option command
Name            Type     Default               Information
mater           Switch                        material specification
	Gas             Boolean  0                    a material
	gas             Boolean  0                    a material
	SiO2            Boolean  0                    a material
	sio2            Boolean  0                    a material
	Oxide           Boolean  0                    a material
	oxide           Boolean  0                    a material
	SpOx            Boolean  0                    a material
	GateOx          Boolean  0                    a material
	HfO2            Boolean  0                    a material
	hfo2            Boolean  0                    a material
	Si3N4           Boolean  0                    a material
	si3n4           Boolean  0                    a material
	Nitride         Boolean  0                    a material
	nitride         Boolean  0                    a material
	Silicon         Boolean  0                    a material
	silicon         Boolean  0                    a material
	Si              Boolean  0                    a material
	Germanium       Boolean  0                    a material
	Germanium       Boolean  0                    a material
	Ge              Boolean  0                    a material
	SiGe            Boolean  0                    a material
	sige            Boolean  0                    a material
	SiliconGermanium Boolean  0                    a material
	SiliconGe       Boolean  0                    a material
	SiGermanium     Boolean  0                    a material
	4HSiC           Boolean  0                    a material
	4hsic           Boolean  0                    a material
	6HSiC           Boolean  0                    a material
	6hsic           Boolean  0                    a material
	3CSiC           Boolean  0                    a material
	3csic           Boolean  0                    a material
	GaN             Boolean  0                    a material
	gan             Boolean  0                    a material
	AlGaN           Boolean  0                    a material
	algan           Boolean  0                    a material
	AlN             Boolean  0                    a material
	aln             Boolean  0                    a material
	Polysilicon     Boolean  0                    a material
	poly            Boolean  0                    a material
	Poly            Boolean  0                    a material
	polySilicon     Boolean  0                    a material
	PolySilicon     Boolean  0                    a material
	polySi          Boolean  0                    a material
	PolySi          Boolean  0                    a material
	Polysi          Boolean  0                    a material
	Oxynitride      Boolean  0                    a material
	oxynitride      Boolean  0                    a material
	Photoresist     Boolean  0                    a material
	PR              Boolean  0                    a material
	pr              Boolean  0                    a material
	photoresist     Boolean  0                    a material
	Metal           Boolean  0                    a material
	metal           Boolean  0                    a material
	Niobium         Boolean  0                    a material
	Nb              Boolean  0                    a material
	niobium         Boolean  0                    a material
	niob            Boolean  0                    a material
	NiobiumOxide    Boolean  0                    a material
	NbOx            Boolean  0                    a material
	nioboxide       Boolean  0                    a material
	niobOxide       Boolean  0                    a material
	niobiumOxide    Boolean  0                    a material
	niobiumoxide    Boolean  0                    a material
	Aluminum        Boolean  0                    a material
	Al              Boolean  0                    a material
	Alum            Boolean  0                    a material
	alum            Boolean  0                    a material
	aluminum        Boolean  0                    a material
	AluminumOxide   Boolean  0                    a material
	AlOx            Boolean  0                    a material
	alumoxide       Boolean  0                    a material
	alumOxide       Boolean  0                    a material
	aluminumOxide   Boolean  0                    a material
	aluminumoxide   Boolean  0                    a material
	semi            Boolean  0                    a material
	Invisible       Boolean  0                    a material
	Insulator       Boolean  0                    a material
inverse         Boolean  0                    do inverse fft
nx              Int      101                  number of x points
ny              Int      101                  number of y points
nz              Int      101                  number of z points
data            String                        Tcl list of data fields
Examples:
  • Test/Coverage/cov_fftmesh.tcl
  • Test/fft/fft_test.tcl

fs

module: field · source: src/field/PermStore/fs.cc

Option Type Default Description
name String fieldserver name
add Boolean 0 make a new fieldserver
list Boolean 0 list all or current fieldservers
delete Boolean 0 delete a fieldserver
select Boolean 0 make name the current fieldserver
current Boolean 0 return name of current fieldserver
interpolate Boolean 0 interpolate data from name server onto the current one
compare Boolean 0 compare two fieldservers (current and name=), same is 1 and different returns 0
tol Float 1.000000e-12 tolerance for field server comparisons
md5 Boolean 0 get the md5 hash of current fs
info Boolean 0 return an info dictionary
data String list of data for interpolation
units String per-fs unit override (cm, um, or nm). Use with add to set at creation, or alone to set on the current fs. Omit to leave the fs on the global options default.
clearunits Boolean 0 drop the current fs's unit override and resume using the global options default
Raw -help output
fs
Length Scale Default is microns which can be changed with the option command
Name            Type     Default               Information
name            String                        fieldserver name
add             Boolean  0                    make a new fieldserver
list            Boolean  0                    list all or current fieldservers
delete          Boolean  0                    delete a fieldserver
select          Boolean  0                    make name the current fieldserver
current         Boolean  0                    return name of current fieldserver
interpolate     Boolean  0                    interpolate data from name server onto the current one
compare         Boolean  0                    compare two fieldservers (current and name=), same is 1 and different returns 0
tol             Float    1.000000e-12         tolerance for field server comparisons
md5             Boolean  0                    get the md5 hash of current fs
info            Boolean  0                    return an info dictionary
data            String                        list of data for interpolation
units           String                        per-fs unit override (cm, um, or nm). Use with add to set at creation, or alone to set on the current fs. Omit to leave the fs on the global options default.
clearunits      Boolean  0                    drop the current fs's unit override and resume using the global options default
Examples:
  • Test/Coverage/cov_fs_units_add.tcl
  • Test/Coverage/cov_fs_units_clear.tcl
  • Test/Coverage/cov_fs_units_fallback.tcl
  • Test/Coverage/cov_fs_units_help.tcl
  • Test/Coverage/cov_fs_units_legacy.tcl

isocontour

module: field · source: src/field/MarchingExtract.cc

Option Type Default Description
src String source FieldServer name (default: current)
field String Z_Plot_Var RealData field name on src (default: most recent sel z=)
out String output FieldServer name
level Float 0.000000e+00 iso level for f - level = 0 (default: 0)
Raw -help output
isocontour
Length Scale Default is microns which can be changed with the option command
Name            Type     Default               Information
src             String                        source FieldServer name (default: current)
field           String   Z_Plot_Var           RealData field name on src (default: most recent sel z=)
out             String                        output FieldServer name
level           Float    0.000000e+00         iso level for f - level = 0 (default: 0)
Examples:
  • Test/Coverage/cov_isocontour.tcl

locationspacingpairs

module: field · source: src/field/voxel/PointCloud.cc

Option Type Default Description
xv Float 0.000000e+00 x component of location
yv Float 0.000000e+00 y component of location
zv Float 0.000000e+00 z component of location
spacing Float 1.000000e-02 desired spacing
Raw -help output
line
Length Scale Default is microns which can be changed with the option command
Name            Type     Default               Information
xv              Float    0.000000e+00         x component of location
yv              Float    0.000000e+00         y component of location 
zv              Float    0.000000e+00         z component of location 
spacing         Float    1.000000e-02         desired spacing

meshvoxel

module: field · source: src/field/voxel/voxel_mesh.cc

Option Type Default Description
2D Boolean 0 generate 2D mesh using front
refine Boolean 0 2D only, call triangle 2x with maxarea set by pointclouds
Total_mesh bd_time .584e-06
Raw -help output
Length Scale Default is microns which can be changed with the option command
Name            Type     Default               Information
2D              Boolean  0                    generate 2D mesh using front 
refine          Boolean  0                    2D only,  call triangle 2x with maxarea set by pointclouds  
     Total_meshvbd_time 7.584e-06

mirror

module: field · source: src/field/mirror.cc

Option Type Default Description
side Switch which bounding-box face to reflect about
top Boolean 0 mirror about Top (X-min) face — 1D/2D/3D
bottom Boolean 0 mirror about Bottom (X-max) face — 1D/2D/3D
left Boolean 0 mirror about Left (Y-min) face — 2D/3D
right Boolean 0 mirror about Right (Y-max) face — 2D/3D
front Boolean 0 mirror about Front (Z-min) face — 3D only
back Boolean 0 mirror about Back (Z-max) face — 3D only
n Int 1 number of linear-march mirror operations (n=1 doubles, n=k tiles k+1 copies along axis)
Raw -help output
mirror
Length Scale Default is microns which can be changed with the option command
Name            Type     Default               Information
side            Switch                        which bounding-box face to reflect about
	top             Boolean  0                    mirror about Top (X-min) face — 1D/2D/3D
	bottom          Boolean  0                    mirror about Bottom (X-max) face — 1D/2D/3D
	left            Boolean  0                    mirror about Left (Y-min) face — 2D/3D
	right           Boolean  0                    mirror about Right (Y-max) face — 2D/3D
	front           Boolean  0                    mirror about Front (Z-min) face — 3D only
	back            Boolean  0                    mirror about Back (Z-max) face — 3D only
n               Int      1                    number of linear-march mirror operations (n=1 doubles, n=k tiles k+1 copies along axis)
Examples:
  • Test/Coverage/cov_mirror_1d.tcl
  • Test/Coverage/cov_mirror_2d.tcl
  • Test/Coverage/cov_mirror_3d.tcl
  • Test/Coverage/cov_mirror_n2.tcl
  • Test/mirror/mirror_2d_multi_region.tcl

pointcloud

module: field · source: src/field/voxel/PointCloud.cc

Option Type Default Description
dir Switch which direction?
x Boolean 0 x params for pc
y Boolean 0 y params for pc
z Boolean 0 x params for pc
location Float 0.000000e+00 location
spacing Float 1.000000e-02 desired spacing
mtrspacing Float 1.000000e-02 mtrdesired spacing
mtrscale Float 1.000000e+00 scale all the mtr spacings by this factor
name String name of pointcloud
build2d Boolean 0 build 2d areas / points for triangle refinement for all pointclouds
defaultarea Float 1.000000e-04 default max area for 2d areas / points for triangle refinement if point not contact
Raw -help output
pointcloud
Length Scale Default is microns which can be changed with the option command
Name            Type     Default               Information
dir             Switch                        which direction?
	x               Boolean  0                    x params for pc 
	y               Boolean  0                    y params for pc 
	z               Boolean  0                    x params for pc 
location        Float    0.000000e+00         location
spacing         Float    1.000000e-02         desired spacing
mtrspacing      Float    1.000000e-02         mtrdesired spacing
mtrscale        Float    1.000000e+00         scale all the mtr spacings by this factor 
name            String                        name of pointcloud
build2d         Boolean  0                    build 2d areas / points for triangle refinement for all pointclouds 
defaultarea     Float    1.000000e-04          default max area for 2d areas / points for triangle refinement if point not contact  

refine

module: field · source: src/field/refine.cc

Option Type Default Description
err String 1 boolean error expression - true if needs refinement
mingrid Float 5.000000e-04 min grid spacing in default length scale
faces Boolean 0 add points to center of faces for 3D tetgen meshes
volumes Boolean 0 add points to center of volumes for 3D tetgen meshes
edges Boolean 1 add points to center of edges for 3D tetgen meshes
tetgen Boolean 0 use tetgen for 3D remeshing instead of internal reduce
Raw -help output
refine
Length Scale Default is microns which can be changed with the option command
Name            Type     Default               Information
err             String   1                    boolean error expression - true if needs refinement
mingrid         Float    5.000000e-04         min grid spacing in default length scale
faces           Boolean  0                    add points to center of faces for 3D tetgen meshes
volumes         Boolean  0                    add points to center of volumes for 3D tetgen meshes
edges           Boolean  1                    add points to center of edges for 3D tetgen meshes
tetgen          Boolean  0                    use tetgen for 3D remeshing instead of internal reduce
Examples:
  • Test/Coverage/cov_3d_refine_reduce.tcl
  • Test/Coverage/cov_adapt_split.tcl
  • Test/Coverage/cov_basedata_node_ops.tcl
  • Test/Coverage/cov_complex_mesh_adapt.tcl
  • Test/Coverage/cov_edge_tri_ops.tcl

simplex

module: field · source: src/field/simplex.cc

Option Type Default Description
all Boolean 1 refine all elements or just odd shaped ones
Raw -help output
simplex
Length Scale Default is microns which can be changed with the option command
Name            Type     Default               Information
all             Boolean  1                    refine all elements or just odd shaped ones

tetgenopts

module: field · source: src/field/voxel/tetgenopts_tcl.cc

Option Type Default Description
triangle Boolean 0 subsequent options apply to Triangle, not TetGen
material String per-material override; if absent, knob applies globally
dobottomx Boolean 0 extend mesh to a flat bottom at bottomval
bottomval Float 0.000000e+00 z coordinate of the extended bottom
domtr Boolean 0 use per-material mtr field for tetgen mesh density
dofacets Boolean 0 constrain facets in tetgen
facetarea Float 0.000000e+00 maximum facet area for tetgen
dovolume Int 0 use volumetric constraints (0/1/2)
maxvol Float 0.000000e+00 maximum tetrahedron volume (global or per-material)
doextrapnts Boolean 0 insert extra points from point cloud
doprevpnts Boolean 0 insert previous mesh points as constraints
dobgmtr Boolean 0 use background mesh-density grid
options String raw tetgen / triangle options string
mtr Float 0.000000e+00 per-material tetgen mesh density
maxarea Float 0.000000e+00 per-material maximum triangle area
doarea Boolean 0 Triangle: enforce per-element area cap
matid Int 0 per-material integer ID for etchvdb
Raw -help output
tetgenopts
Length Scale Default is microns which can be changed with the option command
Name            Type     Default               Information
triangle        Boolean  0                    subsequent options apply to Triangle, not TetGen
material        String                        per-material override; if absent, knob applies globally
dobottomx       Boolean  0                    extend mesh to a flat bottom at bottomval
bottomval       Float    0.000000e+00         z coordinate of the extended bottom
domtr           Boolean  0                    use per-material mtr field for tetgen mesh density
dofacets        Boolean  0                    constrain facets in tetgen
facetarea       Float    0.000000e+00         maximum facet area for tetgen
dovolume        Int      0                    use volumetric constraints (0/1/2)
maxvol          Float    0.000000e+00         maximum tetrahedron volume (global or per-material)
doextrapnts     Boolean  0                    insert extra points from point cloud
doprevpnts      Boolean  0                    insert previous mesh points as constraints
dobgmtr         Boolean  0                    use background mesh-density grid
options         String                        raw tetgen / triangle options string
mtr             Float    0.000000e+00         per-material tetgen mesh density
maxarea         Float    0.000000e+00         per-material maximum triangle area
doarea          Boolean  0                    Triangle: enforce per-element area cap
matid           Int      0                    per-material integer ID for etchvdb