Interface class used by boundary condition classes. Defines the methods used to monitor the boundaries of the computation domain. More...
Public Member Functions | |
void | readShape (XMLParser shapeRoot, Domain aDomain) |
Reads the coordinates that specify a boundary from the protocol file, creating a shape. More... | |
Boolean | isOutside (ContinuousVector cc) |
Test if a given set of coordinates is outside this shape. More... | |
Boolean | isOnBoundary (ContinuousVector cC, double res) |
ContinuousVector | intersection (ContinuousVector position, ContinuousVector vector) |
Calculates the coordinates of the interaction between a line (point a vector) and the plane. More... | |
void | orthoProj (ContinuousVector ccIn, ContinuousVector ccOut) |
Correct coordinates of a point that has gone outside this shape. More... | |
ContinuousVector | getOrthoProj (ContinuousVector ccIn) |
Correct coordinates of a point that has gone outside this shape, returning these coordinates. More... | |
double | getDistance (IsShape aShape) |
Used in cyclic boundaries - gets the distance from the opposite side (aShape) More... | |
double | getDistance (ContinuousVector cc) |
Used in cyclic boundaries - gets the distance from a point on the other side (ContinuousVector) More... | |
ContinuousVector | getNormalInside (ContinuousVector cc) |
Takes a vector and returns that vector pointing towards the inside of the shape. More... | |
void | readyToFollowBoundary (SpatialGrid aSG) |
Initialisation to create the features of and go along the boundary. More... | |
boolean | followBoundary (DiscreteVector dcIn, DiscreteVector dcOut, SpatialGrid aSG) |
Find the next valid point. More... | |
DiscreteVector | getNormalDC () |
Return vector normal to the plane. More... | |
Interface class used by boundary condition classes. Defines the methods used to monitor the boundaries of the computation domain.
Interface class used by boundary condition classes. Defines the methods used to monitor the boundaries of the computation domain
boolean simulator.geometry.shape.IsShape.followBoundary | ( | DiscreteVector | dcIn, |
DiscreteVector | dcOut, | ||
SpatialGrid | aSG | ||
) |
Find the next valid point.
Find the next valid point
dcIn | Discrete vector within the shape |
dcOut | Discrete vector outside the shape |
aSG | Spatial grid in which the boundary is associated |
Implemented in simulator.geometry.shape.Planar.
double simulator.geometry.shape.IsShape.getDistance | ( | IsShape | aShape | ) |
Used in cyclic boundaries - gets the distance from the opposite side (aShape)
Used in cyclic boundaries - gets the distance from the opposite side (aShape)
Implemented in simulator.geometry.shape.Planar.
double simulator.geometry.shape.IsShape.getDistance | ( | ContinuousVector | cc | ) |
Used in cyclic boundaries - gets the distance from a point on the other side (ContinuousVector)
Used in cyclic boundaries - gets the distance from a point on the other side (ContinuousVector)
Implemented in simulator.geometry.shape.Planar.
DiscreteVector simulator.geometry.shape.IsShape.getNormalDC | ( | ) |
Return vector normal to the plane.
Return vector normal to the plane
Implemented in simulator.geometry.shape.Planar.
ContinuousVector simulator.geometry.shape.IsShape.getNormalInside | ( | ContinuousVector | cc | ) |
Takes a vector and returns that vector pointing towards the inside of the shape.
Takes a vector and returns that vector pointing towards the inside of the shape
cc | Vector outside the shape |
Implemented in simulator.geometry.shape.Planar.
ContinuousVector simulator.geometry.shape.IsShape.getOrthoProj | ( | ContinuousVector | ccIn | ) |
Correct coordinates of a point that has gone outside this shape, returning these coordinates.
Correct coordinates of a point that has gone outside this shape, returning these coordinates
ccIn | Coordinates to be corrected |
Implemented in simulator.geometry.shape.Planar.
ContinuousVector simulator.geometry.shape.IsShape.intersection | ( | ContinuousVector | position, |
ContinuousVector | vector | ||
) |
Calculates the coordinates of the interaction between a line (point a vector) and the plane.
Calculates the coordinates of the interaction between a line (point a vector) and the plane. Returns null if none exists
position | Position used to calculate the line |
vector | Vector of coordinate positions used to calculate the line |
Implemented in simulator.geometry.shape.Planar.
Boolean simulator.geometry.shape.IsShape.isOnBoundary | ( | ContinuousVector | cC, |
double | res | ||
) |
Computes orthogonal distance and if this distance is lower than the resolution and if the point is outside, then the point tested is declared to be on the boundary of the domain
cC | ContinuousVector containing the coordinates of a point to test |
res | Resolution of the domain that this shape is associated with |
Implemented in simulator.geometry.shape.Planar.
Boolean simulator.geometry.shape.IsShape.isOutside | ( | ContinuousVector | cc | ) |
Test if a given set of coordinates is outside this shape.
Test if a given set of coordinates is outside this shape
cc | ContinuousVector containing the coordinates of a point to test |
Implemented in simulator.geometry.shape.Planar.
void simulator.geometry.shape.IsShape.orthoProj | ( | ContinuousVector | ccIn, |
ContinuousVector | ccOut | ||
) |
Correct coordinates of a point that has gone outside this shape.
Correct coordinates of a point that has gone outside this shape
ccIn | Coordinates to be corrected |
ccOut | Corrected coordinates |
Implemented in simulator.geometry.shape.Planar.
Reads the coordinates that specify a boundary from the protocol file, creating a shape.
Reads the coordinates that specify a boundary from the protocol file, creating a shape
shapeRoot | XML elements from the protocol file that contain coordinates specifying the edge of a boundary |
aDomain | The computation domain that this boundary is associated with |
Implemented in simulator.geometry.shape.Planar.
void simulator.geometry.shape.IsShape.readyToFollowBoundary | ( | SpatialGrid | aSG | ) |
Initialisation to create the features of and go along the boundary.
Initialisation to create the features of and go along the boundary
aSG | The grid to which this boundary is a part |
Implemented in simulator.geometry.shape.Planar.