Infinite cylinder Shape. More...

#include <MathCylinder.hxx>

Inheritance diagram for MathCylinder:

Public Member Functions
Constructors
	MathCylinder (double R=0.01, double X=0, double Y=0, double Z=0, double dX=0, double dY=0, double dZ=1, int Sign=- 1)

Get shape parameters
unsigned	IsCylinder () override

double	GetR ()

double	GetX ()

double	GetY ()

double	GetZ ()

vector< double >	GetOrigin ()

double	GetdX ()

double	GetdY ()

double	GetdZ ()

vector< double >	GetAxisVector ()

Shape transformations
void	Translate (double dx, double dy, double dz, int count=0) override

void	Rotate (double phi, double theta=0, double psi=0, double *center=nullptr, int count=0) override

Relations with other shapes
unsigned	IsIncluded (Shape_ptr OtherShape) override
	return 1 if the Cylinder is included in OtherShape otherwise 0

unsigned	IsDisjoint (Shape_ptr OtherShape) override
	return 1 if the Cylinder is disjoint of OtherShape otherwise 0

Public Member Functions inherited from Shape
	Shape ()
	Default constructor. The interior of a Shape is built.

	Shape (const Shape &s)
	Copy constructor.

	~Shape () override
	Normal destructor.

Shape_ptr	Not ()
	Return the complementary Shape (i.e. the other side)

void	NewNot ()

void	SetClone (Shape_ptr clone)

void	SetClone2Not ()
	Set the CloneShape to a Not.

int	GetSign ()

void	SetSign (int s)

void	SetOutermostShape (bool flag=true)
	Say that this Shape is the most outer one.

virtual unsigned	IsBrick ()

virtual unsigned	IsFullVoid ()

virtual unsigned	IsHexagon ()

virtual unsigned	IsNode ()

virtual unsigned	IsPlane ()

virtual unsigned	IsSphere ()

virtual unsigned	IsTube ()

virtual unsigned	IsFull ()

virtual unsigned	IsVoid ()

virtual unsigned	IsZTorus ()

bool	IsInfinite ()

virtual double	GetVolume ()
	Get the Volume of a Shape.

void	SetVolume (double V)

virtual double	GetArea ()
	Get the Area of a Shape.

void	SetArea (double S)

virtual void	SetMirrorBoundary (bool state=true)
	mirror a particle on the surface

virtual void	SetTopBottomPlanesOpen ()

virtual bool	IsTopBottomPlanesOpen ()

virtual void	SetSidePlanesOpen ()

virtual bool	IsSidePlanesOpen ()

virtual void	SetWhiteBoundary (bool state=true)

virtual void	SetPeriodicBoundary (bool state=true, string TopBottPlaneBC="mirror")
	Periodic boundary (WARNING: only for Brick and Hexagon).

virtual bool	IsMirrorBoundary ()

virtual bool	IsWhiteBoundary ()

virtual bool	IsPeriodicBoundary ()

virtual unsigned	Add (Shape_ptr OtherShape)
	Add a new Shape (in fact a Shape_ptr) to a Node.

virtual void	ReplaceLeaf (int i, Shape_ptr OtherShape)

unsigned	AddInsideShape (Shape_ptr OtherShape)
	Add a Shape in fInsideShape each time a "put in" is done.

unsigned	AddOriginalInsideShape (Shape_ptr OtherShape)
	This method is called by Shape::AddInsideShape.

void	ClearOriginalInsideShape ()

void	ClearInsideShape ()

unsigned	GetInsideShapeSize ()

unsigned	GetOriginalInsideShapeSize ()

void	SetInsideShape (int i, Shape_ptr S)

void	SetOriginalInsideShape (int i, Shape_ptr S)

Shape_ptr	GetInsideShape (int i)

Shape_ptr	GetOriginalInsideShape (int i)

virtual Shape_ptr	GetLeaf (int i)

virtual int	GetNumberOfLeaves ()

string	GetShapeName ()
	returns the Shape name

virtual int	NumberOfShapes ()

void	SetDebugName (string str)

string	GetDebugName ()

virtual void	SetUniverse (int u=- 1)
	Set the Universe number for a Shape .

virtual void	SetFill (int f)

int	GetFill ()

int	GetUniverse ()

void	IncrementSurface (double S)

virtual double	GetVirtualSphereRadius ()

virtual void	RemoveSurface ()

virtual string	Print ()

virtual void	PrintX (int count=0)
	Debug method: Print the shape surface when fMouvement=true.

virtual void	PrintY (int count=0)
	Debug method: Print the shape surfaces, InsideShape, ...

virtual void	SetLinkedPlane (Shape_ptr P)

virtual void	ReplaceNode (Shape_ptr C)
	Replace a Node by an other (C must be a Node)

virtual SurfaceCard *	GetSurfaceCard ()

virtual SurfaceCard *	GetSurfaceCard (int i)

virtual void	ResetIsDefinedSurfaceCalled ()

virtual void	Simplify (bool violent=false)
	Simplify a tree of Node.

virtual void	SetMouvement (bool state=true)

virtual void	UnSetMouvement ()
	Set the fMouvement flag to false;.

bool	GetMouvement ()

virtual void	DevElague (int count=0, bool violent=false)
	Developps and Trims a tree of Node.

void	SetViolentSimplify (bool Allowed=true)
	Enable/disable violent simplification a certain shapes to avoid "union" (for Serpent outside)

void	SetFreezeSimplify (bool flag=true)
	Enable/disable simplification a certain nodes to avoid "union" (for Serpent outside)

bool	IsViolentSimplifyAllowed ()

virtual int	GetMonoSurfaceType ()

void	SetInfinite ()

Public Member Functions inherited from TReference
	TReference ()

virtual	~TReference ()=default
	Destructor.

void	AddReference (unsigned n=1)

unsigned	DelReference (unsigned n=1)

unsigned	Reference ()

Miscellaneous methods
double	fR
	Radius of the Cylinder.

vector< double >	fOrigin
	origin of the cylinder

vector< double >	fAxisVector
	cylinder axis vector

bool	PointInShape (double *P, int border) override

Shape_ptr	Clone (int count=0) override
	Clone a Shape.

void	Copy (Shape_ptr C) override
	Copy all attributs of a Shape (but not attributs of the father classes).

void	CalculNot () override
	Allocates and calculs the complement of a Cylinder.

double *	GetVirtualSphereCenter () override
	returns the center of a Sphere containing the Shape

void	Norme ()
	Normalisation of axis vector.

MathCylinder *	CreateNewInstance (int sign=1) override
	a new MathCylinder instance.

Additional Inherited Members
Protected Member Functions inherited from Shape
virtual void	MinimumCopy (Shape *S)
	Copy all attributs of a Shape S (but not attributs of the father classes).

void	SetNot (Shape *aNot)
	Allocates and calculs the complement of Shape.

void	SetNotofNot ()

Protected Attributes inherited from Shape
vector< Shape_ptr >	fInsideShape
	a vector to remember which Shapes are inside the current one.Clear at each ">>"

vector< Shape_ptr >	fOriginalInsideShape
	a vector to remember which Shapes are inside the current one.

int	fSign
	Define whether the interior (-1) or the exterior (+1) of the Shape is considered.

bool	fInfinite
	Determines whether the shape is infinite or not.

Shape *	fNot
	pointer on complementary Shape if exists, else 0.

bool	fMouvement
	Flag that indicate a Shape is in mouvement (translation, ..) in a tree.

int	fUniverse
	Universe number (for lattice filling)

int	fFill
	Universe number that fill the Shape.

double	fVolume
	the Volume of a Shape;

double	fArea
	the area of a Shape;

string	fShapeName
	Name of a Shape.

string	fDebugName
	Debug Name of a Shape.

double	fVirtualSphereR
	the radius of a Sphere containing the Shape

double *	fVirtualSphereO
	the center of a Sphere containing the Shape

Shape_ptr	fCloneShape
	the clone of a Shape

bool	fMirrorBoundary
	whether or not mirror a particle on the surface

bool	fOpenZPlanes
	whether the top/bottom planes are not mirrors (default=false)

bool	fOpenXYPlanes
	whether the side planes are not mirrors (default=false)

bool	fWhiteBoundary
	whether or not mirror a particle on the surface with a cosine distribution

bool	fPeriodicBoundary
	whether or not Periodic boundary are applied (only for plane)

string	fTopBottPlaneBoundaryCondition
	whether the top(bottom) plane of a periodic boundary Shape is white or mirror

Shape_ptr	fLinkedPlane
	the Plane linked to an this for periodic boundary

bool	fIsViolentSimplifyAllowed
	whether or not a "violent simplification is allowed (ie a Node or a Brick are allowed to be separated)

bool	fOutermostShape
	whether or not this Shape is the limit to the exterior world (for calculating particle losses).

bool	fFreezeSimplify
	disable any Node simplification (for serpent in ReactorAssembly)

Detailed Description

Infinite cylinder Shape.

Define an (infinite) cylinder Shape. Default: Interior of an origin center cylinder of radius 0.01m and z-axis (in MCNP CZ 1) It is defined by the axis (fdX, fdY, fdZ), an origin on the axis (fX, fY, fZ), and a radius (fR). It is only a mathematical shape (no link to any code output).User should use Cylinder (from MCNP or Serpent namespace).

Author: WEC; PTO; J. Hajnrych

Version: 2.0

Constructor & Destructor Documentation

◆ MathCylinder()

MathCylinder::MathCylinder	(	double	R = `0.01`,
		double	X = `0`,
		double	Y = `0`,
		double	Z = `0`,
		double	dX = `0`,
		double	dY = `0`,
		double	dZ = `1`,
		int	Sign = `- 1`
	)

Normal Constructor. Default: Interior of an origin center Cylinder of radius 0.01m and z-axis (in MCNP CZ 1)

Parameters

R	: radius of the Cylinder
X	: x-position of its center
Y	: y-position of its center
Z	: z-position of its center
dX	: 1st component of the axis vector
dY	: 2nd component of the axis vector
dZ	: 3th component of the axis vector
Sign	: whether interior (-1) or exterior (+1) of the Cylinder is considered

Member Function Documentation

◆ CalculNot()

void MathCylinder::CalculNot ( )

overridevirtual

Allocates and calculs the complement of a Cylinder.

Reimplemented from Shape.

◆ Clone()

Shape_ptr MathCylinder::Clone ( int count = 0 )

overridevirtual

Clone a Shape.

Implements Shape.

◆ Copy()

void MathCylinder::Copy ( Shape_ptr C )

overridevirtual

Copy all attributs of a Shape (but not attributs of the father classes).

Reimplemented from Shape.

◆ CreateNewInstance()

MathCylinder * MathCylinder::CreateNewInstance ( int sign = 1 )

overrideprotectedvirtual

a new MathCylinder instance.

Implements Shape.

◆ GetAxisVector()

vector< double > MathCylinder::GetAxisVector ( )

inline

< return the 3 coordinate vector of the Sphere Origin

◆ GetdX()

double MathCylinder::GetdX ( )

inline

< return 1st component of the axis vector

◆ GetdY()

double MathCylinder::GetdY ( )

inline

< return 2nd component of the axis vector

◆ GetdZ()

double MathCylinder::GetdZ ( )

inline

< return 3th component of the axis vector

◆ GetOrigin()

vector< double > MathCylinder::GetOrigin ( )

inline

< return the 3 coordinate vector of the Sphere Origin

◆ GetR()

double MathCylinder::GetR ( )

inline

< return Radius of the Sphere

◆ GetVirtualSphereCenter()

double * MathCylinder::GetVirtualSphereCenter ( )

overridevirtual

returns the center of a Sphere containing the Shape

Reimplemented from Shape.

◆ GetX()

double MathCylinder::GetX ( )

inline

< return x-position of its center

◆ GetY()

double MathCylinder::GetY ( )

inline

< return y-position of its center

◆ GetZ()

double MathCylinder::GetZ ( )

inline

< return z-position of its center

◆ IsCylinder()

unsigned MathCylinder::IsCylinder ( )

inlineoverridevirtual

< 1 if Shape is a Cylinder

Reimplemented from Shape.

◆ IsDisjoint()

unsigned MathCylinder::IsDisjoint ( Shape_ptr OtherShape )

overridevirtual

return 1 if the Cylinder is disjoint of OtherShape otherwise 0

Implements Shape.

◆ IsIncluded()

unsigned MathCylinder::IsIncluded ( Shape_ptr OtherShape )

overridevirtual

return 1 if the Cylinder is included in OtherShape otherwise 0

Implements Shape.

◆ Norme()

void MathCylinder::Norme ( )

protected

Normalisation of axis vector.

◆ PointInShape()

bool MathCylinder::PointInShape	(	double *	P,
		int	border
	)

overridevirtual

true if the point P is in the Shape.

Parameters

P	: a (x, y, z) point of space
border	: =-1 : if P is at the Shape surface then P is inside or =+1 : if P is at the Shape surface then P is outside

Reimplemented from Shape.

◆ Rotate()

void MathCylinder::Rotate	(	double	phi,
		double	theta = `0`,
		double	psi = `0`,
		double *	center = `nullptr`,
		int	count = `0`
	)

overridevirtual

Rotate the Shape clockwise.

Parameters

phi	: arround z axis
theta	: arround y axis
psi	: arround x axis
center	: the center of rotation (Default=origin)
count	: normal used is default (=0) ; usefull to know the recursion depth

Implements Shape.

◆ Translate()

void MathCylinder::Translate	(	double	dx,
		double	dy,
		double	dz,
		int	count = `0`
	)

overridevirtual

Translate the Node of (dx, dy, dz).

Parameters

dx	: translation along x-axis
dy	: translation along y-axis
dz	: translation along z-axis
count	: normal used is default (=0) ; usefull to know the recursion depth

Implements Shape.

Member Data Documentation

◆ fAxisVector

vector< double > MathCylinder::fAxisVector

protected

cylinder axis vector

◆ fOrigin

vector< double > MathCylinder::fOrigin

protected

origin of the cylinder

◆ fR

double MathCylinder::fR

protected

Radius of the Cylinder.

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

/gpr/meplan/SMURE/source/include/MathCylinder.hxx
/gpr/meplan/SMURE/source/src/MathCylinder.cxx

Public Member Functions

Miscellaneous methods

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MathCylinder()

Member Function Documentation

◆ CalculNot()

◆ Clone()

◆ Copy()

◆ CreateNewInstance()

◆ GetAxisVector()

◆ GetdX()

◆ GetdY()

◆ GetdZ()

◆ GetOrigin()

◆ GetR()

◆ GetVirtualSphereCenter()

◆ GetX()

◆ GetY()

◆ GetZ()

◆ IsCylinder()

◆ IsDisjoint()

◆ IsIncluded()

◆ Norme()

◆ PointInShape()

◆ Rotate()

◆ Translate()

Member Data Documentation

◆ fAxisVector

◆ fOrigin

◆ fR