This function defines an Archimedes' screw in the z-direction from a (constant) starting point, a (constant) length L, a (constant) radius r, a (constant) number or revelations N and a (constant) rotation speed (rev/s) More...

#include <HorizontalScrew.h>

Inheritance diagram for HorizontalScrew:

Public Member Functions
	HorizontalScrew ()
	Default constructor: make a screw with default parameters. More...

	HorizontalScrew (const HorizontalScrew &other)
	Copy constructor, copies another HorizontalScrew. More...

	HorizontalScrew (Vec3D start, Mdouble l, Mdouble minR, Mdouble lowerR, Mdouble diffR, Mdouble n, Mdouble omega, Mdouble thickness, const ParticleSpecies *s)
	Constructor in which all parameters of the screw are set. More...

	~HorizontalScrew ()
	Default destructor. More...

HorizontalScrew *	copy () const final
	Copy this screw and return a pointer to the copy. More...

bool	getDistanceAndNormal (const BaseParticle &P, Mdouble &distance, Vec3D &normal_return) const final
	Compute the distance from the HorizontalScrew for a given BaseParticle and return if there is a collision. If there is a collision, also return the normal vector of the interaction point. More...

Mdouble	getLength () const
	Returns the length of the HorizontalScrew. More...

Vec3D	getStart () const
	Returns the starting position of the HorizontalScrew. More...

void	move_time (Mdouble dt)
	Rotate the HorizontalScrew for a period dt, so that the offset_ changes with omega_*dt. More...

void	read (std::istream &is) override
	Reads a HorizontalScrew from an input stream, for example a restart file. More...

void	write (std::ostream &os) const override
	Writes this HorizontalScrew to an output stream, for example a restart file. More...

std::string	getName () const final
	Returns the name of the object, here the string "HorizontalScrew". More...

void	writeVTK (VTKContainer &vtk) const override

void	setBlades (const Mdouble bladeWidth, const Mdouble bladeLength, const std::vector< Mdouble > bladeMounts)

Public Member Functions inherited from BaseWall
	BaseWall ()
	Default constructor. More...

	BaseWall (const BaseWall &w)
	Copy constructor. More...

	~BaseWall () override
	Default destructor. More...

virtual bool	getDistanceNormalOverlap (const BaseParticle &P, Mdouble &distance, Vec3D &normal_return, Mdouble &overlap) const

virtual bool	getDistanceNormalOverlapSuperquadric (const SuperQuadricParticle &p, Mdouble &distance, Vec3D &normal_return, Mdouble &overlap) const

virtual Vec3D	getFurthestPointSuperQuadric (const Vec3D &normalBodyFixed, const Vec3D &axes, Mdouble eps1, Mdouble eps2) const

virtual void	setHandler (WallHandler *handler)
	A function which sets the WallHandler for this BaseWall. More...

WallHandler *	getHandler () const
	A function which returns the WallHandler that handles this BaseWall. More...

void	setIndSpecies (unsigned int indSpecies) override
	Define the species of this wall using the index of the species in the SpeciesHandler in this DPMBase. More...

void	setSpecies (const ParticleSpecies *species)
	Defines the species of the current wall. More...

bool	isFixed () const override

void	setForceControl (Vec3D forceGoal, Vec3D gainFactor, Vec3D baseVelocity={0, 0, 0})
	Slowly adjusts the force on a wall towards a specified goal, by adjusting (prescribing) the velocity of the wall. More...

virtual bool	isLocal (Vec3D &min, Vec3D &max) const

bool	getLinePlaneIntersect (Vec3D &intersect, const Vec3D &p0, const Vec3D &p1, const Vec3D &n, const Vec3D &p)

bool	isInsideWallVTK (const Vec3D &point, const Vec3D &normal, const Vec3D &position) const

void	projectOntoWallVTK (Vec3D &point0, const Vec3D &point1, const Vec3D &normal, const Vec3D &position) const

void	intersectVTK (std::vector< Vec3D > &points, Vec3D normal, Vec3D position) const

virtual BaseInteraction *	getInteractionWithSuperQuad (SuperQuadricParticle p, unsigned timeStamp, InteractionHandler interactionHandler)

void	getVTK (std::vector< Vec3D > &points, std::vector< std::vector< double >> &triangleStrips)

const Vec3D	getAxis () const

BaseInteraction *	getInteractionWith (BaseParticle p, unsigned timeStamp, InteractionHandler interactionHandler) override
	Returns the interaction between this wall and a given particle, nullptr if there is no interaction. More...

virtual void	actionsOnRestart ()
	No implementation but can be overidden in its derived classes. More...

virtual void	actionsAfterParticleGhostUpdate ()
	No implementation but can be overidden in its derived classes. More...

virtual void	handleParticleAddition (unsigned int id, BaseParticle *p)
	Handles the addition of particles to the particleHandler. More...

virtual void	handleParticleRemoval (unsigned int id)
	Handles the addition of particles to the particleHandler. More...

virtual void	checkInteractions (InteractionHandler *interactionHandler, unsigned int timeStamp)
	Check if all interactions are valid. More...

bool	getVTKVisibility () const

void	setVTKVisibility (bool vtkVisibility)

void	addRenderedWall (BaseWall *w)

BaseWall *	getRenderedWall (size_t i) const

std::vector< BaseWall * >	getRenderedWalls () const

void	removeRenderedWalls ()

void	renderWall (VTKContainer &vtk)

void	addParticlesAtWall (unsigned numElements=50)

void	setVelocityControl (Vec3D forceGoal, Vec3D gainFactor, Vec3D baseVelocity)

virtual void	writeWallDetailsVTK (VTKData &data) const

virtual void	computeWear ()

Public Member Functions inherited from BaseInteractable
	BaseInteractable ()
	Default BaseInteractable constructor. More...

	BaseInteractable (const BaseInteractable &p)
	Copy constructor. More...

	~BaseInteractable () override
	Destructor, it simply destructs the BaseInteractable and all the objects it contains. More...

unsigned int	getIndSpecies () const
	Returns the index of the species associated with the interactable object. More...

const ParticleSpecies *	getSpecies () const
	Returns a pointer to the species of this BaseInteractable. More...

void	setSpecies (const ParticleSpecies *species)
	Sets the species of this BaseInteractable. More...

const Vec3D &	getForce () const
	Returns the force on this BaseInteractable. More...

const Vec3D &	getTorque () const
	Returns the torque on this BaseInteractable. More...

void	setForce (const Vec3D &force)
	Sets the force on this BaseInteractable. More...

void	setTorque (const Vec3D &torque)
	Sets the torque on this BaseInteractable. More...

void	addForce (const Vec3D &addForce)
	Adds an amount to the force on this BaseInteractable. More...

void	addTorque (const Vec3D &addTorque)
	Adds an amount to the torque on this BaseInteractable. More...

virtual void	resetForceTorque (int numberOfOMPthreads)

void	sumForceTorqueOMP ()

const Vec3D &	getPosition () const
	Returns the position of this BaseInteractable. More...

const Quaternion &	getOrientation () const
	Returns the orientation of this BaseInteractable. More...

virtual void	setPosition (const Vec3D &position)
	Sets the position of this BaseInteractable. More...

void	setOrientationViaNormal (Vec3D normal)
	Sets the orientation of this BaseInteractable by defining the vector that results from the rotation of the (1,0,0) vector. More...

void	setOrientationViaEuler (Vec3D eulerAngle)
	Sets the orientation of this BaseInteractable by defining the euler angles. More...

virtual void	setOrientation (const Quaternion &orientation)
	Sets the orientation of this BaseInteractable. More...

virtual void	move (const Vec3D &move)
	Moves this BaseInteractable by adding an amount to the position. More...

virtual void	rotate (const Vec3D &angularVelocityDt)
	Rotates this BaseInteractable. More...

const std::vector< BaseInteraction * > &	getInteractions () const
	Returns a list of interactions which belong to this interactable. More...

void	addInteraction (BaseInteraction *I)
	Adds an interaction to this BaseInteractable. More...

bool	removeInteraction (BaseInteraction *I)
	Removes an interaction from this BaseInteractable. More...

void	copyInteractionsForPeriodicParticles (const BaseInteractable &p)
	Copies interactions to this BaseInteractable whenever a periodic copy made. More...

void	setVelocity (const Vec3D &velocity)
	set the velocity of the BaseInteractable. More...

void	setAngularVelocity (const Vec3D &angularVelocity)
	set the angular velocity of the BaseInteractble. More...

void	addVelocity (const Vec3D &velocity)
	adds an increment to the velocity. More...

void	addAngularVelocity (const Vec3D &angularVelocity)
	add an increment to the angular velocity. More...

virtual const Vec3D &	getVelocity () const
	Returns the velocity of this interactable. More...

virtual const Vec3D &	getAngularVelocity () const
	Returns the angular velocity of this interactable. More...

void	setPrescribedPosition (const std::function< Vec3D(double)> &prescribedPosition)
	Allows the position of an infinite mass interactable to be prescribed. More...

void	applyPrescribedPosition (double time)
	Computes the position from the user defined prescribed position function. More...

void	setPrescribedVelocity (const std::function< Vec3D(double)> &prescribedVelocity)
	Allows the velocity of an infinite mass interactable to be prescribed. More...

void	applyPrescribedVelocity (double time)
	Computes the velocity from the user defined prescribed velocity function. More...

void	setPrescribedOrientation (const std::function< Quaternion(double)> &prescribedOrientation)
	Allows the orientation of the infinite mass interactbale to be prescribed. More...

void	applyPrescribedOrientation (double time)
	Computes the orientation from the user defined prescribed orientation function. More...

void	setPrescribedAngularVelocity (const std::function< Vec3D(double)> &prescribedAngularVelocity)
	Allows the angular velocity of the infinite mass interactable to be prescribed. More...

void	applyPrescribedAngularVelocity (double time)
	Computes the angular velocity from the user defined prescribed angular velocity. More...

virtual const Vec3D	getVelocityAtContact (const Vec3D &contact) const
	Returns the velocity at the contact point, use by many force laws. More...

void	integrateBeforeForceComputation (double time, double timeStep)
	This is part of integrate routine for objects with infinite mass. More...

void	integrateAfterForceComputation (double time, double timeStep)
	This is part of the integration routine for objects with infinite mass. More...

virtual Mdouble	getInvMass () const

virtual Mdouble	getCurvature (const Vec3D &labFixedCoordinates) const

virtual bool	isFaceContact (const Vec3D &normal) const

Public Member Functions inherited from BaseObject
	BaseObject ()=default
	Default constructor. More...

	BaseObject (const BaseObject &p)=default
	Copy constructor, copies all the objects BaseObject contains. More...

virtual	~BaseObject ()=default
	virtual destructor More...

virtual void	moveInHandler (unsigned int index)
	Except that it is virtual, it does the same thing as setIndex() does. More...

void	setIndex (unsigned int index)
	Allows one to assign an index to an object in the handler/container. More...

void	setId (unsigned long id)
	Assigns a unique identifier to each object in the handler (container) which remains constant even after the object is deleted from the container/handler. More...

unsigned int	getIndex () const
	Returns the index of the object in the handler. More...

unsigned int	getId () const
	Returns the unique identifier of any particular object. More...

void	setGroupId (unsigned groupId)

unsigned	getGroupId () const

Private Attributes
Vec3D	start_
	The centre of the lower end of the screw. More...

Mdouble	l_
	The length of the HorizontalScrew. More...

Mdouble	minR_
	The outer radius of the HorizontalScrew. More...

Mdouble	lowerR_

Mdouble	diffR_

Mdouble	n_
	The number of revelations. More...

Mdouble	omega_
	Rotation speed in rev/s. More...

Mdouble	offset_
	The angle that describes how much the HorizontalScrew has turned, going from 0 to 1 for a rotation. More...

Mdouble	thickness_
	The thickness of the HorizontalScrew. More...

Mdouble	bladeWidth_
	The maximum radial width of a blade (in r). More...

Mdouble	bladeLength_
	The length of a blade (in the q-coordinate, which is a linear mapping from start.Z<z<start.Z+l to 0<q<1). More...

std::vector< Mdouble >	bladeMounts_
	The starting point of a blade (in the q-coordinate, which is a linear mapping from start.Z<z<start.Z+l to 0<q<1) More...

Additional Inherited Members
Static Public Member Functions inherited from BaseWall
static void	addToVTK (const std::vector< Vec3D > &points, VTKContainer &vtk)
	Takes the points provided and adds a triangle strip connecting these points to the vtk container. More...

Detailed Description

This function defines an Archimedes' screw in the z-direction from a (constant) starting point, a (constant) length L, a (constant) radius r, a (constant) number or revelations N and a (constant) rotation speed (rev/s)

q is a new coordinate going from 0 to 1 and t is the time, x=xs+r*cos(2*pi*(offset+N*q)), y=ys+r*sin(2*pi*(offset+N*q)), z=zs+q*L

Todo:: IFCD: Can these details about class HorizontalScrew be made more clear? I don't understand them.

Constructor & Destructor Documentation

◆ HorizontalScrew() [1/3]

HorizontalScrew::HorizontalScrew ( )

Default constructor: make a screw with default parameters.

Make a HorizontalScrew which is centered in the origin, has a length of 1, one revelation, a radius of 1, turns with 1 revelation per second, is infinitely thin and starts at its normal initial point.

 {
     start_.setZero();
     l_ = 1.0;
     minR_ = 0.0;
     lowerR_ = 1.0;
     diffR_ = 0.0;
     n_ = 1.0;
     omega_ = 1.0;
     offset_ = 0.0;
     thickness_ = 0.0;
     bladeLength_=0;
     bladeWidth_=0;
     bladeMounts_={};
     logger(DEBUG, "HorizontalScrew() constructor finished.");
 }

References bladeLength_, bladeMounts_, bladeWidth_, DEBUG, diffR_, l_, logger, lowerR_, minR_, n_, offset_, omega_, Vec3D::setZero(), start_, and thickness_.

Referenced by copy().

◆ HorizontalScrew() [2/3]

HorizontalScrew::HorizontalScrew ( const HorizontalScrew & other )

Copy constructor, copies another HorizontalScrew.

Parameters

[in] other The HorizontalScrew that has to be copied.

     : BaseWall(other)
 {
     start_ = other.start_;
     l_ = other.l_;
     minR_ = other.minR_;
     lowerR_ = other.lowerR_;
     diffR_ = other.diffR_;
     n_ = other.n_;
     omega_ = other.omega_;
     thickness_ = other.thickness_;
     offset_ = other.offset_;
     bladeLength_=other.bladeLength_;
     bladeWidth_=other.bladeWidth_;
     bladeMounts_=other.bladeMounts_;
     logger(DEBUG, "HorizontalScrew(const HorizontalScrew&) copy constructor finished.");
 }

References bladeLength_, bladeMounts_, bladeWidth_, DEBUG, diffR_, l_, logger, lowerR_, minR_, n_, offset_, omega_, start_, and thickness_.

◆ HorizontalScrew() [3/3]

HorizontalScrew::HorizontalScrew	(	Vec3D	start,
		Mdouble	l,
		Mdouble	minR,
		Mdouble	lowerR,
		Mdouble	diffR,
		Mdouble	n,
		Mdouble	omega,
		Mdouble	thickness,
		const ParticleSpecies *	s
	)

Constructor in which all parameters of the screw are set.

Parameters

[in]	start	A Vec3D which denotes the centre of the lower end of the HorizontalScrew.
[in]	l	The length of the HorizontalScrew, must be positive.
[in]	r	The radius of the HorizontalScrew, must be positive.
[in]	n	The number of revelations of the HorizontalScrew, must be positive.
[in]	omega	The rotation speed of the HorizontalScrew in rev/s.
[in]	thickness	The thickness of the HorizontalScrew, must be non-negative.

Make a HorizontalScrew by assigning all input parameters to the data-members of this class, and setting the offset_ to 0.

 {
     start_ = start;
     l_ = l;
     minR_ = minR;
     lowerR_ = lowerR;
     diffR_ = diffR;
     n_ = n;
     omega_ = omega;
     thickness_ = thickness;
     offset_ = 0.0;
     bladeLength_=0;
     bladeWidth_=0;
     bladeMounts_={};
     setSpecies(s);
     logger(DEBUG, "HorizontalScrew(Vec3D, Mdouble, Mdouble, Mdouble, Mdouble, Mdouble) constructor finished.");
 }

References bladeLength_, bladeMounts_, bladeWidth_, DEBUG, diffR_, l_, logger, lowerR_, minR_, n, n_, offset_, omega_, BaseWall::setSpecies(), start_, and thickness_.

◆ ~HorizontalScrew()

HorizontalScrew::~HorizontalScrew ( )

Default destructor.

 {
     logger(DEBUG, "~HorizontalScrew() finished, destroyed the HorizontalScrew.");
 }

References DEBUG, and logger.

Member Function Documentation

◆ copy()

HorizontalScrew * HorizontalScrew::copy ( ) const

finalvirtual

Copy this screw and return a pointer to the copy.

Returns: A pointer to a copy of this HorizontalScrew.

Implements BaseWall.

 {
     return new HorizontalScrew(*this);
 }

References HorizontalScrew().

◆ getDistanceAndNormal()

bool HorizontalScrew::getDistanceAndNormal	(	const BaseParticle &	p,
		Mdouble &	distance,
		Vec3D &	normal_return
	)		const

finalvirtual

Compute the distance from the HorizontalScrew for a given BaseParticle and return if there is a collision. If there is a collision, also return the normal vector of the interaction point.

Parameters

[in]	p	BaseParticle we want to calculate the distance and whether it collided of.
[out]	distance	The distance of the BaseParticle to this wall.
[out]	normal_return	If there was a collision, the normal vector to this wall will be placed here.

Returns: A boolean which says whether or not there was a collision.

This function computes whether or not there is a collision between a given BaseParticle and this HorizontalScrew. If there is a collision, this function also computes the distance between the BaseParticle and HorizontalScrew and the normal of the IntersectionOfWalls at the intersection point.

Todo:: Make this function readable and explain the steps in the details.

Implements BaseWall.

 {
     Mdouble RSquared = square(p.getPosition().X - start_.X) + square(p.getPosition().Y - start_.Y);
     Mdouble Z = p.getPosition().Z - start_.Z;
     //first do a simple check if particle is within the cylindrical hull of the screw
     Mdouble maxR = std::max(minR_,lowerR_+diffR_*Z/l_)+bladeWidth_;//todo: fix
     Mdouble interactionRadius = p.getWallInteractionRadius(this) + thickness_;
     if (RSquared > square(maxR + interactionRadius)
         || Z > l_ + interactionRadius
         || Z < - interactionRadius)
     {
         return false;
     }
  
     //else:
     Mdouble R = sqrt(RSquared);
     Mdouble A = atan2(p.getPosition().Y - start_.Y, p.getPosition().X - start_.X);
  
     //after subtracting the start position and transforming the particle position from (XYZ) into (RAZ)
     //coordinates, we compute the distance to the wall at, located at (r,a,z)=(r,2*pi*(offset+N*q+k/2),q*L), 0<q<1.
  
     //To find the contact point we have to minimize (with respect to r and q)
     //distance^2=(x-x0-r*cos(2*pi*(offset+N*q)))^2+(y-y0-r*sin(2*pi*(offset+N*q)))^2+(z-z0-q*L)^2
     //Using polar coordinates (i.e. x-x0=R*cos(A), y-y0=R*sin(A) and Z=z-z0)
     //distance^2=R^2+r^2-2*R*r*cos(A-2*pi*(offset+N*q))+(Z-q*L)^2
  
     //Assumption: d(distance)/dr=0 at minDistance (should there be also a q-derivative?)
     //Differentiate with respect to r and solve for zero:
     //0=2*r-2*R*cos(A-2*pi*(offset+N*q)
     //r=R*cos(A-2*pi*(offset+N*q))
  
     //Substitue back
     //distance^2=R^2+R^2*cos^2(A-2*pi*(offset+N*q))-2*R^2*cos^2(A-2*pi*(offset+N*q))+(Z-q*L)^2
     //distance^2=R^2*sin^2(A-2*pi*(offset+N*q))+(Z-q*L)^2
  
     //So we have to minimize:
     //distance^2=R^2*sin^2(A-2*pi*(offset+N*q))^2 + (Z-q*L)^2 = f(q)
     //f'(q)=(-2*pi*N)*R^2*sin(2*A-4*pi*(offset+N*q)) + 2*L*(Z-q*L)    (D[Sin[x]^2,x]=Sin[2x])
     //f''(q)=(4*pi^2*N^2)*R^2*cos(2*A-4*pi*(offset+N*q)) - 2*L*L
     //For this we use the Euler algoritm
  
     Mdouble q; //Current guess
     Mdouble dd; //Derivative at current guess
     Mdouble ddd; //Second derivative at current guess
     Mdouble q0 = Z / l_; //assume closest point q0 is at same z-location as the particle
  
     //Set initial q to the closest position on the screw with the same angle as A
     //The initial guess will be in the minimum of the sin closest to q0
     //Minima of the sin are at
     //A-2*pi*(offset+N*q)=k*pi (k=integer)
     //q=A/(2*pi*N)-k/(2*N)-offset/N (k=integer)
  
     Mdouble k = round(A / constants::pi - 2.0 * (offset_ + n_ * q0)); // k: |A-a(q0)-k*pi|=min
     q = A / (2.0 * constants::pi * n_) - k / (2.0 * n_) - offset_ / n_; // q: a(q)=A
  
     //this makes the trioliet screw unique: only one turn
     if (((int)k)%2==0)
         return false;
  
     //Now apply Newton's method to find the rel height q of the contact point
     do
     {
         Mdouble arg = 2.0 * A - 4.0 * constants::pi * (n_ * q + offset_);
         dd = -2.0 * constants::pi * n_ * RSquared * sin(arg) - 2.0 * l_ * (Z - q * l_);
         ddd = 8.0 * constants::sqr_pi * n_ * n_ * RSquared * cos(arg) + 2.0 * l_ * l_;
         q -= dd / ddd;
     } while (fabs(dd / ddd) > 1e-14);
  
     //Calculate r
     Mdouble r = R * cos(2.0 * constants::pi * (offset_ + n_ * q) - A);
     maxR = std::max(minR_,lowerR_+diffR_*q);//todo: fix
     for (auto b : bladeMounts_)
     {
         Mdouble dq = q-b;
         if (dq>0 && dq<bladeLength_)
         {
             maxR += bladeWidth_*(dq/bladeLength_);
         }
     }
  
     //Check if the location is actually on the screw:
     //First possibility is that the radius is too large:
     if (fabs(r) > maxR) //Left boundary of the coil
     {
         //either the contact point is too far from the screw ...
         if (fabs(r) > maxR+thickness_)
             return false;
         //... or we have to compute the contact around the edge
         r = mathsFunc::sign(r) * maxR;
         //This case reduces to the coil problem
         do
         {
             dd = -4.0 * R * r * constants::pi * n_ * sin(A - 2.0 * constants::pi * (n_ * q + offset_)) - 2.0 * l_ * (Z - q * l_);
             ddd = 8.0 * R * r * constants::sqr_pi * n_ * n_ * cos(A - 2.0 * constants::pi * (n_ * q + offset_)) + 2.0 * l_ * l_;
             q -= dd / ddd;
         } while (fabs(dd / ddd) > 1e-14);
     }
     //Second possibility is that it occurred before the start of after the end
     if (q < 0)
     {
         q = 0;
         r = R * cos(A - 2.0 * constants::pi * (offset_ + q * n_));
         if (fabs(r) > maxR)
         {
             r = mathsFunc::sign(r) * maxR;
         }
     }
     else if (q > 1)
     {
         q = 1;
         r = R * cos(A - 2.0 * constants::pi * (offset_ + q * n_));
         if (fabs(r) > maxR)
         {
             r = mathsFunc::sign(r) * maxR;
         }
     }
  
     Mdouble distanceSquared = square(R*sin(A - 2 * constants::pi * (offset_ + n_ * q))) + square(Z - q * l_);
     //If distance is too large there is no contact
     if (distanceSquared >= square(interactionRadius))
     {
         return false;
     }
  
     Vec3D ContactPoint;
     distance = sqrt(distanceSquared) - thickness_;
     ContactPoint.X = start_.X + r * cos(2.0 * constants::pi * (offset_ + n_ * q));
     ContactPoint.Y = start_.Y + r * sin(2.0 * constants::pi * (offset_ + n_ * q));
     ContactPoint.Z = start_.Z + q * l_;
     normal_return = (ContactPoint - p.getPosition());
     normal_return.normalise();
     return true;
 }

References A, bladeLength_, bladeMounts_, bladeWidth_, mathsFunc::cos(), diffR_, BaseInteractable::getPosition(), BaseParticle::getWallInteractionRadius(), l_, lowerR_, minR_, n_, Vec3D::normalise(), offset_, constants::pi, R, helpers::round(), mathsFunc::sign(), mathsFunc::sin(), constants::sqr_pi, mathsFunc::square(), start_, thickness_, Vec3D::X, Vec3D::Y, Vec3D::Z, and Z.

◆ getLength()

Mdouble HorizontalScrew::getLength ( ) const

Returns the length of the HorizontalScrew.

 {
     return l_;
 }

References l_.

◆ getName()

std::string HorizontalScrew::getName ( ) const

finalvirtual

Returns the name of the object, here the string "HorizontalScrew".

Returns: The string "HorizontalScrew".

Implements BaseObject.

 {
     return "HorizontalScrew";
 }

◆ getStart()

Vec3D HorizontalScrew::getStart ( ) const

Returns the starting position of the HorizontalScrew.

 {
     return start_;
 }

References start_.

◆ move_time()

void HorizontalScrew::move_time ( Mdouble dt )

Rotate the HorizontalScrew for a period dt, so that the offset_ changes with omega_*dt.

Parameters

[in] dt The time for which the HorizontalScrew has to be turned.

 {
     offset_ += omega_ * dt;
 }

References offset_, and omega_.

Referenced by HorizontalMixer::actionsAfterTimeStep(), and HorizontalMixer::setScrewWalls().

◆ read()

void HorizontalScrew::read ( std::istream & is )

overridevirtual

Reads a HorizontalScrew from an input stream, for example a restart file.

Parameters

[in,out] is Input stream from which the HorizontalScrew must be read.

Reimplemented from BaseWall.

 {
     BaseWall::read(is);
     std::string dummy;
     unsigned n=0;
     is >> dummy >> start_
             >> dummy >> l_
             >> dummy >> minR_
             >> dummy >> lowerR_
             >> dummy >> diffR_
             >> dummy >> n_
             >> dummy >> omega_
             >> dummy >> thickness_
             >> dummy >> offset_
             >> dummy >> bladeLength_
             >> dummy >> bladeWidth_
             >> dummy >> n;
     for (unsigned i=0; i<n; i++) {
         Mdouble val;
         is >> val;
         bladeMounts_.push_back(val);
     }
 }

References bladeLength_, bladeMounts_, bladeWidth_, diffR_, constants::i, l_, lowerR_, minR_, n, n_, offset_, omega_, BaseWall::read(), start_, and thickness_.

◆ setBlades()

void HorizontalScrew::setBlades	(	const Mdouble	bladeWidth,
		const Mdouble	bladeLength,
		const std::vector< Mdouble >	bladeMounts
	)

 {
     bladeWidth_ = bladeWidth;
     bladeLength_ = bladeLength;
     bladeMounts_ = bladeMounts;
 }

References bladeLength_, bladeMounts_, and bladeWidth_.

◆ write()

void HorizontalScrew::write ( std::ostream & os ) const

overridevirtual

Writes this HorizontalScrew to an output stream, for example a restart file.

Parameters

[in,out] os Output stream to which the HorizontalScrew must be written.

Reimplemented from BaseWall.

 {
     BaseWall::write(os);
     os << " start " << start_
             << " length " << l_
             << " minRadius " << minR_
             << " lowerRadius " << lowerR_
             << " diffRadius " << diffR_
             << " revolutions " << n_
             << " omega " << omega_
             << " thickness " << thickness_
             << " offset " << offset_
             << " bladeLength " << bladeLength_
             << " bladeWidth " << bladeWidth_
             << " bladeMounts " << bladeMounts_.size();
     for (auto n : bladeMounts_)
         os << " " << n;
 }

References bladeLength_, bladeMounts_, bladeWidth_, diffR_, l_, lowerR_, minR_, n, n_, offset_, omega_, start_, thickness_, and BaseWall::write().

◆ writeVTK()

void HorizontalScrew::writeVTK ( VTKContainer & vtk ) const

overridevirtual

adds extra information to the points and triangleStrips vectors needed to plot the wall in vtk format

Parameters

points	Coordinates of the vertices of the triangulated surfaces (in the VTK file this is called POINTS)
triangleStrips	Indices of three vertices forming one triangulated surface (in the VTK file this is called CELL)

Reimplemented from BaseWall.

 {
     unsigned nr = 10;
     unsigned nz = 180;
  
     unsigned nPoints = vtk.points.size();
     Vec3D contactPoint;
     for (unsigned iz=0; iz<nz; iz++) {
         double maxR = std::max(minR_,lowerR_+(double)iz/nz*diffR_);//todo: fix
         for (auto b : bladeMounts_)
         {
             Mdouble dq = (double)iz/nz-b;
             if (dq>0 && dq<bladeLength_)
             {
                 maxR += bladeWidth_*(dq/bladeLength_);
             }
         }
         for (unsigned ir=0; ir<nr; ir++) {
             double q = (double)iz/nz;
             double r = (double)ir/nr*maxR;
             contactPoint.X = start_.X - r * cos(2.0 * constants::pi * (offset_ + n_ * q));
             contactPoint.Y = start_.Y - r * sin(2.0 * constants::pi * (offset_ + n_ * q));
             contactPoint.Z = start_.Z + q * l_;
             vtk.points.push_back(contactPoint);
         }
     }
  
     for (unsigned iz=0; iz<nz-1; iz++) {
         std::vector<double> cell;
         cell.reserve(2*nr);
         for (unsigned ir=0; ir<nr; ir++) {
             cell.push_back(nPoints+ir+iz*nr);
             cell.push_back(nPoints+ir+(iz+1)*nr);
         }
         vtk.triangleStrips.push_back(cell);
     }
 }