Lattice Class

A wrapped FDTD Lattice object attached to a Domain.

Inheritance Hierarchy

SystemObject
ema3d.Api.V25.Core.DomainDomainChildBaseLattice
ema3d.Api.V25.Core.DomainLattice

Namespace: ema3d.Api.V25.Core.Domain
Assembly: ema3d.Api.V25 (in ema3d.Api.V25.dll) Version: 0.0.0.0

Syntax

C++

Copy

public sealed class Lattice : DomainChildBase<Lattice>

Public NotInheritable Class Lattice
	Inherits DomainChildBase(Of Lattice)

public ref class Lattice sealed : public DomainChildBase<Lattice^>

[<SealedAttribute>]
type Lattice = 
    class
        inherit DomainChildBase<Lattice>
    end

The Lattice type exposes the following members.

Properties

	Name	Description
	Bounds	Gets/Sets lattice bounds with a Box object.
	Divisions	Gets/Sets MPI block divisions.
	DivisionsX	Gets/Sets number of MPI divisions along the x-axis in lattice.
	DivisionsY	Gets/Sets number of MPI divisions along the y-axis in lattice.
	DivisionsZ	Gets/Sets number of MPI divisions along the z-axis in lattice.
	Maximum	Gets/Sets maximum point in the lattice.
	MaximumX	Gets/Sets Maximum x value in lattice.
	MaximumY	Gets/Sets Maximum y value in lattice.
	MaximumZ	Gets/Sets Maximum z value in lattice.
	Minimum	Gets/Sets minimum point in the lattice.
	MinimumX	Gets/Sets minimum x value in lattice.
	MinimumY	Gets/Sets minimum y value in lattice.
	MinimumZ	Gets/Sets minimum z value in lattice.
	ShadeRendering	Gets/Sets if lattice box sides should be shaded.
	ShowIncrements	Gets/Sets if text increments should be rendered.
	ShowMajorGridlines	Gets/Sets if major gridlines should be shown.
	ShowMinorGridlines	Gets/Sets if minor gridlines should be shown.
	StepSize	Gets/Sets the step size in the lattice for each coordinate direction.
	StepSizeX	Gets/Sets Step Size x value in lattice.
	StepSizeY	Gets/Sets Step Size y value in lattice.
	StepSizeZ	Gets/Sets Step Size z value in lattice.
	XCount	Gets the number of cells in the x direction.
	YCount	Gets the number of cells in the y direction.
	ZCount	Gets the number of cells in the z direction.

Top

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	SetBounds	Sets lattice bounds with a Box object.
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Remarks

This object is always attached to a parent FDTD Domain and cannot be created individually. Modifications to, and copies of, this object will operate on the single FDTD domain within the document.

Example

Python

Copy

from ema3d.Api.V25.Core.Domain import Domain as Domain

# Get/Create Domain
_dom = Domain.GetInstance()
# Modify Lattice
_dom.Lattice.StepSize = Point.Create(0.01, 0.01, 0.01)
_dom.Lattice.Minimum = Point.Create(0.1,0.1,0.1)
_dom.Lattice.Maximum = Point.Create(1.0, 1.0, 1.0)

Reference

ema3d.Api.V25.Core.Domain Namespace