fr.cnes.sirius.patrius.math.geometry.euclidean.threed

Class RightCircularSurfaceCylinder

java.lang.Object

fr.cnes.sirius.patrius.math.geometry.euclidean.threed.RightCircularSurfaceCylinder

All Implemented Interfaces:

CrossSectionProvider

public class RightCircularSurfaceCylinder
extends Object
implements CrossSectionProvider

Cylinder shape class.

Author:

sumelzi

Constructor Summary

Constructors

Constructor and Description
RightCircularSurfaceCylinder(double xAxisSurfIn, double transversalSurfIn) Creates a new instance of a cylinder.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
double	getCrossSection(Vector3D direction) Computes the cross section from the direction defined by a Vector3D.
double	getEquivalentTransversalSurf() Get equivalent transversal surface.
double	getLength() Get length corresponding to transversal surface (x length) (m).
static double	getLengthFromTSurfaceAndRadius(double tarnsversalSurf, double radius) Get length from the transversal surface and radius.
double	getRadius() Get radius corresponding to perpendicular x axis surface (m).
double	getSurfX() Get surface perpendicular to X axis (m2).
double	getTransversalSurf() Get transversal surface (m2).
static double	getTSurfaceFromRadiusAndLength(double radius, double length) Get transversal surface from radius and length.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RightCircularSurfaceCylinder

public RightCircularSurfaceCylinder(double xAxisSurfIn,
                                    double transversalSurfIn)

Creates a new instance of a cylinder.

Parameters:

xAxisSurfIn - surface perpendicular to X axis (m2)

transversalSurfIn - transversal surface (m2)

Method Detail

getCrossSection

public double getCrossSection(Vector3D direction)
                       throws ArithmeticException

Computes the cross section from the direction defined by a Vector3D.

Specified by:

getCrossSection in interface CrossSectionProvider

Parameters:

direction - the direction vector

Returns:

the cross section

Throws:

ArithmeticException - if in direction, x, y or z are NaN or if they are all 0

getSurfX

public double getSurfX()

Get surface perpendicular to X axis (m2).

Returns:

the surface perpendicular to X axis

getRadius

public double getRadius()

Get radius corresponding to perpendicular x axis surface (m).

Returns:

the radius

getLength

public double getLength()
                 throws IllegalArgumentException

Get length corresponding to transversal surface (x length) (m).

Returns:

the length

Throws:

IllegalArgumentException - if radius is negative or zero (undetermined length)

getEquivalentTransversalSurf

public double getEquivalentTransversalSurf()

Get equivalent transversal surface. This surface is used in order to modelize the cylinder as a parallelepiped (m2).

Returns:

the transveral surface of the equivalent parallelepiped

getTransversalSurf

public double getTransversalSurf()

Get transversal surface (m2).

Returns:

the transversal surface

getLengthFromTSurfaceAndRadius

public static double getLengthFromTSurfaceAndRadius(double tarnsversalSurf,
                                                    double radius)
                                             throws IllegalArgumentException

Get length from the transversal surface and radius.

Parameters:

tarnsversalSurf - cylinder transversal surface

radius - cylinder radius

Returns:

the cylinder length

Throws:

IllegalArgumentException - if radius is negative or zero (undetermined length)

getTSurfaceFromRadiusAndLength

public static double getTSurfaceFromRadiusAndLength(double radius,
                                                    double length)

Get transversal surface from radius and length.

Parameters:

radius - cylinder radius

length - cylinder length

Returns:

the surface

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object