yade-dev team mailing list archive

Thread
Date

[Branch ~yade-dev/yade/trunk] Rev 2084: - Use of YADE_CLASS_BASE_DOC_* macro family in KinemCNDENgine (it was not in r2082, contrary to w...

To: Yade developers <yade-dev@xxxxxxxxxxxxxxxxxxx>
From: noreply@xxxxxxxxxxxxx
Date: Wed, 17 Mar 2010 10:34:25 -0000
Reply-to: noreply@xxxxxxxxxxxxx
Sender: bounces@xxxxxxxxxxxxx

------------------------------------------------------------
revno: 2084
committer: jduriez <jduriez@c1solimara-l>
branch nick: trunk
timestamp: Wed 2010-03-17 11:29:22 +0100
message:
  - Use of YADE_CLASS_BASE_DOC_* macro family in KinemCNDENgine (it was not in r2082, contrary to what was previously said)
modified:
  pkg/dem/Engine/PartialEngine/KinemCNDEngine.cpp
  pkg/dem/Engine/PartialEngine/KinemCNDEngine.hpp


--
lp:yade
https://code.launchpad.net/~yade-dev/yade/trunk

Your team Yade developers is subscribed to branch lp:yade.
To unsubscribe from this branch go to https://code.launchpad.net/~yade-dev/yade/trunk/+edit-subscription.

=== modified file 'pkg/dem/Engine/PartialEngine/KinemCNDEngine.cpp'
--- pkg/dem/Engine/PartialEngine/KinemCNDEngine.cpp	2010-03-16 16:02:55 +0000
+++ pkg/dem/Engine/PartialEngine/KinemCNDEngine.cpp	2010-03-17 10:29:22 +0000
@@ -12,25 +12,13 @@
 #include"KinemCNDEngine.hpp"
 
 
-KinemCNDEngine::KinemCNDEngine() : leftbox(new Body), rightbox(new Body), topbox(new Body)
-{
-	gamma_save.resize(0);
-	temoin_save.resize(0);
-	temoinfin=0;
-	shearSpeed=0;
-	gamma=0;
-	gammalim=0;
-	id_boxhaut=3;
-	id_boxleft=0;
-	id_boxright=2;
-}
 
 
 void KinemCNDEngine::applyCondition(Scene * ncb)
 {
 	leftbox = Body::byId(id_boxleft);
 	rightbox = Body::byId(id_boxright);
-	topbox = Body::byId(id_boxhaut);
+	topbox = Body::byId(id_topbox);
 
 	if( ((shearSpeed > 0) && (gamma<=gammalim)) || ((shearSpeed < 0) /*&& (gamma>=gammalim)*/ ) )
 	{

=== modified file 'pkg/dem/Engine/PartialEngine/KinemCNDEngine.hpp'
--- pkg/dem/Engine/PartialEngine/KinemCNDEngine.hpp	2010-03-16 16:02:55 +0000
+++ pkg/dem/Engine/PartialEngine/KinemCNDEngine.hpp	2010-03-17 10:29:22 +0000
@@ -12,18 +12,12 @@
 #include<yade/core/PartialEngine.hpp>
 #include<yade/lib-base/Math.hpp>
 
-/*! \brief To apply a zero normal displacement shear for a parallelogram box
-
-This engine, used in simulations issued from "SimpleShear" Preprocessor, allows to translate horizontally the upper plate while the lateral ones rotate so that they always keep contact with the lower and upper walls
-*/
-
 
 class KinemCNDEngine : public PartialEngine
 {
 	private :
 		Real	alpha	// angle from the lower plate to the left box (trigo wise), the Engine finds itself its value
 			,dalpha	// the increment over alpha, due to vertical displacement of upper box
-			,gamma	// horizontal displacement done since the launch of the calcul first step
 			;
 
 		int temoinfin;
@@ -31,31 +25,31 @@
 		shared_ptr<Body> rightbox;
 		shared_ptr<Body> topbox;
 
-		void letMove(Scene* body);
+		void letMove(Scene*);
 		void stopMovement();		// to cancel all the velocities when gammalim is reached
 
 
 	public :
-		KinemCNDEngine();
-		void applyCondition(Scene * body),
+		void applyCondition(Scene *),
 			computeAlpha();
 
-		Real	 shearSpeed	// to be defined in the PreProcessor
-			,gammalim 	// the maximum value of gamma (tangential displacemt), in meters, at wich the displacement is stopped
 			;
-		body_id_t 	id_boxhaut,	// the id of the upper wall : defined in the constructor
-				id_boxleft,
-				id_boxright;
-		std::vector<Real>	gamma_save	// the values of gamma, in meters, at which a save is performed
-					,temoin_save
-					;
-		string Key;
 
 	protected :
-// 		YADE_CLASS_BASE_DOCS_ATTRS(KinemCNDEngine,PartialEngine
-	REGISTER_ATTRIBUTES(PartialEngine,(shearSpeed)(gammalim)(gamma)(gamma_save)(temoin_save)(id_boxhaut)(id_boxleft)(id_boxright)(Key));
-	REGISTER_CLASS_NAME(KinemCNDEngine);
-	REGISTER_BASE_CLASS_NAME(PartialEngine);
+
+		YADE_CLASS_BASE_DOC_ATTRS_CTOR(KinemCNDEngine,PartialEngine,
+			"To apply a constant normal displacement shear for a parallelogram box\n\n \tThis engine, designed for simulations implying a simple shear box (:yref:`SimpleShear` Preprocessor), allows to perform a constant normal displacement shear, by translating horizontally the upper plate, while the lateral ones rotate so that they always keep contact with the lower and upper walls.",
+			((Real,shearSpeed,0.0,"the speed at which the shear is performed : speed of the upper plate [m/s]"))
+			((Real,gammalim,0.0,"the value of the tangential displacement at wich the displacement is stopped [m]"))
+			((Real,gamma,0.0,"the current value of the tangential displacement"))
+			((std::vector<Real>,gamma_save,,"vector with the values of gamma at which a save of the simulation is performed [m]"))
+			((std::vector<Real>,temoin_save,,"vector (same length as 'gamma_save'), with 0 or 1 depending whether the save for the corresponding value of gamma has been done (1) or not (0)"))
+			((body_id_t,id_topbox,3,"the id of the upper wall"))
+			((body_id_t,id_boxleft,0,"the id of the left wall"))
+			((body_id_t,id_boxright,2,"the id of the right wall"))
+			((string,Key,"","string to add at the names of the saved files")),
+			temoinfin=0;
+						);
 };
 
 REGISTER_SERIALIZABLE(KinemCNDEngine);