Package empro :: Module empro :: Module mesh :: Class GridGenerator

Class GridGenerator

core.Updatable --+
                 |
                GridGenerator

Interface to the fdtd grid generator.

Class Hierarchy for GridGenerator

Instance Methods

__call__(x, ...)
x(...)

None

addManualFixedPoint(iFixedPoint)
Add a manual fixed point to the grid.

None

addManualGridRegion(iGridRegionParameters)
Add a manual grid region to the grid.

None

clearManualFixedPoints()
Remove all manually added fixed points from the grid.

clearManualGridRegions(...)
No documentation available.

Expression

defaultMaximumCellNumber(iUsePreference)
Returns the default maximum number of cells to be used for the grid.

Expression

defaultMaximumFrequency(iUsePreference)
Returns the default maximal frequency to be used for the grid.

Expression

defaultMaximumStepFactor(iUsePreference)
Returns the default maximum allowed step factor for the size of two adjacent cells in a grid transition region.

femBoundingBox(...)
No documentation available.

list{FixedPoint}

getManualFixedPoints()
Returns all manually added fixed that are currently in the grid.

list{ManualGridRegionParameters}

getManualGridRegions()
Returns all manually added grid regions that are currently in the grid.

Inherited from core.Updatable: __enter__, __exit__, clone, hash, isValid, reasonWhyInvalid

Properties
BoundingBox3DNone	boundingBox Size of the grid bounding box.
CellSizesSpecificationNone	cellSizes Specification of the cell sizes used for the fdtd grid.
	femPadding No documentation available.
	gridSpecificationType No documentation available.
boolNone	includeCircuitComponents Specifies if circuit components are taken into account to determine the grid size.
boolNone	includeUnmeshedObjects Specifies if unmeshed objects are taken into account to determine the grid size.
ExpressionNone	maximumFrequency Maximal frequency for which the grid should give valid results.
ExpressionNone	maximumNumberOfCells Maximum number of cells that can be used for the grid.
ExpressionNone	maximumStepFactor Maximum allowed step factor for the size of two adjacent cells in a grid transition region.
BoundingBox3DNone	padding Number of padding cells.
boolNone	useMaximumFrequency Determines if the grid size should be determined based on a given maximal frequency.
boolNone	useMaximumNumberOfCells Determines if the grid size should be determined based on a given maximum number of cells.

Method Details

addManualFixedPoint(iFixedPoint)

Add a manual fixed point to the grid.

Parameters:

iFixedPoint (FixedPoint) - Fixed point to be added to grid

Returns: None

addManualGridRegion(iGridRegionParameters)

Add a manual grid region to the grid.

Parameters:

iGridRegionParameters (ManualGridRegionParameters) - Grid region to be added to grid

Returns: None

defaultMaximumCellNumber(iUsePreference)

Returns the default maximum number of cells to be used for the grid.

Parameters:

iUsePreference (bool) - Determines whether or not the preferences set from the UI should be used.

Returns: Expression

defaultMaximumFrequency(iUsePreference)

Returns the default maximal frequency to be used for the grid.

Parameters:

iUsePreference (bool) - Determines whether or not the preferences set from the UI should be used.

Returns: Expression

defaultMaximumStepFactor(iUsePreference)

Returns the default maximum allowed step factor for the size of two adjacent cells in a grid transition region.

Parameters:

iUsePreference (bool) - Determines whether or not the preferences set from the UI should be used.

Returns: Expression