Infinite plane Shape (or half space). More...

#include <SerpentPlane.hxx>

Inheritance diagram for Serpent::Plane:

Public Member Functions
	Plane (double A=0, double B=0, double C=1, double D=0, int Sign=- 1)
	Normal Constructor.

Public Member Functions inherited from MathPlane
	MathPlane (double A=0, double B=0, double C=1, double D=0, int Sign=- 1)
	Normal Constructor.

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

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

unsigned	IsPlane () override

double	GetA ()

double	GetB ()

double	GetC ()

double	GetD ()

unsigned	IsIncluded (Shape_ptr OtherShape) override
	return 1 if the Plane is included in OtherShape otherwise 0

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

void	Translate (double dx, double dy, double dz, int count=0) override
	Translate the Node of (dx, dy, dz).

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

bool	PointInShape (double *P, int border) override
	true if the point P is in the Shape.

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

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	IsCylinder ()

virtual unsigned	IsFullVoid ()

virtual unsigned	IsHexagon ()

virtual unsigned	IsNode ()

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 double *	GetVirtualSphereCenter ()

virtual void	RemoveSurface ()

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 (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
Plane *	getXPlane (double D=0, int Sign=- 1)
	return a Plane perpendicular to X-axis

Plane *	getYPlane (double D=0, int Sign=- 1)
	return a Plane perpendicular to Y-axis

Plane *	getZPlane (double D=0, int Sign=- 1)
	return a Plane perpendicular to Z-axis

string	Print () override
	Print the Shape surface in Serpent cell.

SerpentSurfaceCard *	GetSurfaceCard () override
	return the surface card for a Serpent Plane (px, ...)

void	nullateParametersLowerThanPrecision ()
	set all parameter less than a precision to 0

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

void	DefineSurface (SerpentSurfaceCard *&S)
	Define surface card for Serpent.

Additional Inherited Members
Protected Member Functions inherited from MathPlane
void	Norme ()
	Normalisation of Normal vector.

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 MathPlane
double	fA
	1st component of the normal vector

double	fB
	2nd component of the normal vector

double	fC
	3th component of the normal vector

double	fD
	Plane position.

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 plane Shape (or half space).

Equation of the plane is fA*x + fB*y + fC*z - fD = 0. It thus defines one of the 2 half spaces : if fSigne=+1 : fA*x + fB*y + fC*z - fD>0 is considered else it is fA*x + fB*y + fC*z - fD<0.

This is the real implementation to use instead of MathPlane. It mainly redefine print method.

Author: J. Hajnrych

Version: 1.0

Constructor & Destructor Documentation

◆ Plane()

Serpent::Plane::Plane	(	double	A = `0`,
		double	B = `0`,
		double	C = `1`,
		double	D = `0`,
		int	Sign = `- 1`
	)

Normal Constructor.

Default: horizontal plane at the origin z=0. Because sign is <0, it defines the half infinit space perpendicular to z axis below the origin.

Plane of equation is fA*x + fB*y + fC*z - fD = 0.

Normal Vector (A, B, C) to the Plane is normed by the constructor.

Parameters

A	: 1st component of the normal vector
B	: 2nd component of the normal vector
C	: 3th component of the normal vector
D	: Plane position
Sign	: which part of the space is considered Signe=-1 (default) fAx + fBy + fC*z - fD<0

Member Function Documentation

◆ CreateNewInstance()

Plane * Serpent::Plane::CreateNewInstance ( int sign = 1 )

overrideprotectedvirtual

a new Plane instance

Reimplemented from MathPlane.

◆ DefineSurface()

void Serpent::Plane::DefineSurface ( SerpentSurfaceCard *& S )

protected

Define surface card for Serpent.

◆ GetSurfaceCard()

SerpentSurfaceCard * Serpent::Plane::GetSurfaceCard ( )

overridevirtual

return the surface card for a Serpent Plane (px, ...)

Reimplemented from Shape.

◆ getXPlane()

Plane * Serpent::Plane::getXPlane	(	double	D = `0`,
		int	Sign = `- 1`
	)

return a Plane perpendicular to X-axis

◆ getYPlane()

Plane * Serpent::Plane::getYPlane	(	double	D = `0`,
		int	Sign = `- 1`
	)

return a Plane perpendicular to Y-axis

◆ getZPlane()

Plane * Serpent::Plane::getZPlane	(	double	D = `0`,
		int	Sign = `- 1`
	)

return a Plane perpendicular to Z-axis

◆ nullateParametersLowerThanPrecision()

void Serpent::Plane::nullateParametersLowerThanPrecision ( )

set all parameter less than a precision to 0

◆ Print()

string Serpent::Plane::Print ( )