gs_Domain Class Reference

Detailed Description

Grad-Sharvanov domain definitions for TokaMaker with Triangle library meshing.

Public Member Functions
	__init__ (self, rextent=None, zextents=[None, None], rpad=1.2, zpad=[1.2, 1.2], json_filename=None)
	Create a new Grad-Shafranov domain.
	add_annulus (self, inner_countour, inner_name, outer_contour, annulus_name, parent_name=None, angle_tol=30.0, sliver_tol=120.0, small_thresh=None)
	Add annular geometry defining region boundaries to the mesh.
	add_enclosed (self, in_point, name)
	add_polygon (self, contour, name, parent_name=None, angle_tol=30.0, sliver_tol=120.0, small_thresh=None)
	Add polygon geometry defining region boundaries to the mesh.
	add_rectangle (self, rc, zc, w, h, name, parent_name=None, rot=None)
	Add rectangular geometry defining region boundaries to the mesh.
	build_mesh (self, debug=False, merge_thresh=1.E-4, require_boundary=True, setup_only=False)
	Build mesh for specified domains.
	define_region (self, name, dx, reg_type, eta=None, noncontinuous=None, nTurns=None, coil_set=None, allow_xpoints=False, inner_limiter=False)
	Define a new region and its properties (geometry is given in a separate call)
	get_coils (self)
	Get dictionary describing coil regions in domain.
	get_conductors (self)
	Get dictionary describing conducting regions in domain.
	plot_mesh (self, fig, ax, lw=0.5, show_legends=True, col_max=10, split_coil_sets=False)
	Plot machine geometry.
	plot_topology (self, fig, ax, linewidth=None)
	Plot mesh topology.
	save_json (self, filename)
	Create a JSON file containing a description of the mesh.

Public Attributes
	boundary_reg
	mesh
	reg_type_counts
	region_info
	regions
	rextent
	rmax
	rpad
	zextents
	zmax
	zmin
	zpad

Protected Attributes
	_extra_reg_defs
	_lc
	_r
	_reg

Constructor & Destructor Documentation

__init__()

__init__	(		self,
			rextent = None,
			zextents = [None,None],
			rpad = 1.2,
			zpad = [1.2,1.2],
			json_filename = None
	)

Create a new Grad-Shafranov domain.

Parameters

region_list	List of oftpy.Region objects that define mesh
merge_thresh	Distance threshold for merging nearby points

Member Function Documentation

add_annulus()

add_annulus	(		self,
			inner_countour,
			inner_name,
			outer_contour,
			annulus_name,
			parent_name = None,
			angle_tol = 30.0,
			sliver_tol = 120.0,
			small_thresh = None
	)

Add annular geometry defining region boundaries to the mesh.

Parameters

inner_contour	Curve defining inner boundary
inner_name	Name of region enclosed by the inner boundary
outer_contour	Curve defining outer boundary
annulus_name	Name of annular region between inner and outer boundaries
parent_name	Name of region beyond the outer boundary
angle_tol	Corner tolerance used when resampling curve at desired resolution
sliver_tol	Tolerance used for "sliver" region warnings
small_thresh	Tolerance used for "small" curve warnings (default: dx/2)

add_enclosed()

add_enclosed	(		self,
			in_point,
			name
	)

add_polygon()

add_polygon	(		self,
			contour,
			name,
			parent_name = None,
			angle_tol = 30.0,
			sliver_tol = 120.0,
			small_thresh = None
	)

Add polygon geometry defining region boundaries to the mesh.

Parameters

contour	Curve defining polygon
name	Name of region enclosed by the polygon
parent_name	Name of region outside the polygon
angle_tol	Corner tolerance used when resampling curve at desired resolution
sliver_tol	Tolerance used for "sliver" region warnings
small_thresh	Tolerance used for "small" curve warnings (default: dx/2)

add_rectangle()

add_rectangle	(		self,
			rc,
			zc,
			w,
			h,
			name,
			parent_name = None,
			rot = None
	)

Add rectangular geometry defining region boundaries to the mesh.

Parameters

rc	Radial center of rectangle
zc	Vertical center of rectangle
w	Width of rectangle (radial direction)
h	Height of the rectangle (vertical direction)
name	Name of region enclosed by the polygon
parent_name	Name of region outside the polygon
rot	Rotation of rectangle (degrees)

build_mesh()

build_mesh	(		self,
			debug = False,
			merge_thresh = 1.E-4,
			require_boundary = True,
			setup_only = False
	)

Build mesh for specified domains.

Returns

Meshed representation (pts[np,2], tris[nc,3], regions[nc])

define_region()

define_region	(		self,
			name,
			dx,
			reg_type,
			eta = None,
			noncontinuous = None,
			nTurns = None,
			coil_set = None,
			allow_xpoints = False,
			inner_limiter = False
	)

Define a new region and its properties (geometry is given in a separate call)

Parameters

name	Name of region
dx	Target mesh size for region
reg_type	Type of region ("plasma", "vacuum", "boundary", "conductor", or "coil")
eta	Resistivity for "conductor" regions (raises error if region is other type)
nTurns	Number of turns for "coil" regions (raises error if region is other type)
allow_xpoints	Allow X-points in this region (for non-plasma regions only)
inner_limiter	This region forms the inner limiter (valid for non-plasma regions in Dipole mode only)

get_coils()

get_coils

(

self

)

Get dictionary describing coil regions in domain.

Returns

Dictionary of coil regions and attributes

get_conductors()

get_conductors

(

self

)

Get dictionary describing conducting regions in domain.

Returns

Dictionary of conducting regions and attributes

plot_mesh()

plot_mesh	(		self,
			fig,
			ax,
			lw = 0.5,
			show_legends = True,
			col_max = 10,
			split_coil_sets = False
	)

Plot machine geometry.

Parameters

fig	Figure to add to (unused)
ax	Axes to add to (must be scalar, [2], or [2,2])
lw	Width of lines in calls to "triplot()"
show_legends	Show legends for plots with more than one region?
col_max	Maximum number of entries per column in each legend

plot_topology()

plot_topology	(		self,
			fig,
			ax,
			linewidth = None
	)

Plot mesh topology.

Parameters

fig	Figure to add to (unused)
ax	Axes to add to (must be scalar)
linewidth	Line width for plots

save_json()

save_json	(		self,
			filename
	)

Create a JSON file containing a description of the mesh.

Parameters

filename

Path to create JSON file

Member Data Documentation

_extra_reg_defs

_extra_reg_defs

protected

_lc

_lc

protected

_r

_r

protected

_reg

_reg

protected

boundary_reg

boundary_reg

mesh

mesh

reg_type_counts

reg_type_counts

region_info

region_info

regions

regions

rextent

rextent

rmax

rmax

rpad

rpad

zextents

zextents

zmax

zmax

zmin

zmin

zpad

zpad

---

The documentation for this class was generated from the following file:

• /home/runner/work/OpenFUSIONToolkit/OpenFUSIONToolkit/src/python/OpenFUSIONToolkit/TokaMaker/meshing.py