yade-dev team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 3463
committer: Bruno Chareyre <bruno.chareyre@xxxxxxxxxxx>
timestamp: Fri 2014-10-10 13:46:41 +0200
message:
  split TwoPhaseFlowEngine in hpp/cpp for inclusion in child engines
added:
  pkg/pfv/TwoPhaseFlowEngine.hpp
modified:
  pkg/pfv/TwoPhaseFlowEngine.cpp


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

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

=== modified file 'pkg/pfv/TwoPhaseFlowEngine.cpp'
--- pkg/pfv/TwoPhaseFlowEngine.cpp	2014-10-09 17:16:03 +0000
+++ pkg/pfv/TwoPhaseFlowEngine.cpp	2014-10-10 11:46:41 +0000
@@ -16,68 +16,9 @@
 #define TWOPHASEFLOW
 #ifdef TWOPHASEFLOW
 
-#include "FlowEngine_TwoPhaseFlowEngineT.hpp"
-
-/// We can add data to the Info types by inheritance
-class TwoPhaseCellInfo : public FlowCellInfo_TwoPhaseFlowEngineT
-{
-	public:
-  	bool isWRes;
-	bool isNWRes;
-	bool isTrapW;
-	bool isTrapNW;
-	double saturation;
-	bool isImbibition;
-	double trapCapP;//for calculating the pressure of trapped phase, cell->info().p() = pressureNW- trapCapP. OR cell->info().p() = pressureW + trapCapP
-	std::vector<double> poreThroatRadius;
-	double poreBodyRadius;
-	double poreBodyVolume;
-	TwoPhaseCellInfo (void)
-	{
-		isWRes = true; isNWRes = false; isTrapW = false; isTrapNW = false;
-		saturation = 1.0;
-		isImbibition = false;
-		trapCapP = 0;
-		poreThroatRadius.resize(4, 0);
-		poreBodyRadius = 0;
-		poreBodyVolume = 0;
-	}
-	
-};
-
-class TwoPhaseVertexInfo : public FlowVertexInfo_TwoPhaseFlowEngineT {
-	public:
-	//same here if needed
-};
-
-typedef TemplateFlowEngine_TwoPhaseFlowEngineT<TwoPhaseCellInfo,TwoPhaseVertexInfo> TwoPhaseFlowEngineT;
-REGISTER_SERIALIZABLE(TwoPhaseFlowEngineT);
+#include "TwoPhaseFlowEngine.hpp"
+
 YADE_PLUGIN((TwoPhaseFlowEngineT));
-
-class TwoPhaseFlowEngine : public TwoPhaseFlowEngineT
-{
-		double totalCellVolume;
-	public :
-	//We can overload every functions of the base engine to make it behave differently
-	//if we overload action() like this, this engine is doing nothing in a standard timestep, it can still have useful functions
-	virtual void action() {};
-	
-	//If a new function is specific to the derived engine, put it here, else go to the base TemplateFlowEngine
-	//if it is useful for everyone
-	void fancyFunction(Real what);
-
-	YADE_CLASS_BASE_DOC_ATTRS_INIT_CTOR_PY(TwoPhaseFlowEngine,TwoPhaseFlowEngineT,"documentation here",
-	((double,surfaceTension,0.0728,,"Water Surface Tension in contact with air at 20 Degrees Celsius is: 0.0728(N/m)"))
-	((bool,initialWetting,true,,"Initial wetting saturated (=true) or non-wetting saturated (=false)"))
-	((bool, isPhaseTrapped,true,,"If True, both phases can be entrapped by the other, which would correspond to snap-off. If false, both phases are always connected to their reservoirs, thus no snap-off."))
-	
-	,/*TwoPhaseFlowEngineT()*/,
-	,
-	.def("fancyFunction",&TwoPhaseFlowEngine::fancyFunction,(boost::python::arg("what")=0),"test function")
-	)
-	DECLARE_LOGGER;
-};
-REGISTER_SERIALIZABLE(TwoPhaseFlowEngine);
 YADE_PLUGIN((TwoPhaseFlowEngine));
 
 void TwoPhaseFlowEngine::fancyFunction(Real what) {std::cerr<<"yes, I'm a new function"<<std::endl;}

=== added file 'pkg/pfv/TwoPhaseFlowEngine.hpp'
--- pkg/pfv/TwoPhaseFlowEngine.hpp	1970-01-01 00:00:00 +0000
+++ pkg/pfv/TwoPhaseFlowEngine.hpp	2014-10-10 11:46:41 +0000
@@ -0,0 +1,81 @@
+ 
+/*************************************************************************
+*  Copyright (C) 2014 by Bruno Chareyre <bruno.chareyre@xxxxxxxxxxx>     *
+*  Copyright (C) 2013 by T. Sweijen (T.sweijen@xxxxx)                    *
+*  Copyright (C) 2012 by Chao Yuan <chao.yuan@xxxxxxxxxxxxxxx>           *
+*                                                                        *
+*  This program is free software; it is licensed under the terms of the  *
+*  GNU General Public License v2 or later. See file LICENSE for details. *
+*************************************************************************/
+
+// This is an example of how to derive a new FlowEngine with additional data and possibly completely new behaviour.
+// Every functions of the base engine can be overloaded, and new functions can be added
+
+//keep this #ifdef as long as you don't really want to realize a final version publicly, it will save compilation time for everyone else
+//when you want it compiled, you can pass -DDFNFLOW to cmake, or just uncomment the following line
+#ifdef TWOPHASEFLOW
+
+#include "FlowEngine_TwoPhaseFlowEngineT.hpp"
+
+/// We can add data to the Info types by inheritance
+class TwoPhaseCellInfo : public FlowCellInfo_TwoPhaseFlowEngineT
+{
+	public:
+  	bool isWRes;
+	bool isNWRes;
+	bool isTrapW;
+	bool isTrapNW;
+	double saturation;
+	bool isImbibition;
+	double trapCapP;//for calculating the pressure of trapped phase, cell->info().p() = pressureNW- trapCapP. OR cell->info().p() = pressureW + trapCapP
+	std::vector<double> poreThroatRadius;
+	double poreBodyRadius;
+	double poreBodyVolume;
+	TwoPhaseCellInfo (void)
+	{
+		isWRes = true; isNWRes = false; isTrapW = false; isTrapNW = false;
+		saturation = 1.0;
+		isImbibition = false;
+		trapCapP = 0;
+		poreThroatRadius.resize(4, 0);
+		poreBodyRadius = 0;
+		poreBodyVolume = 0;
+	}
+	
+};
+
+class TwoPhaseVertexInfo : public FlowVertexInfo_TwoPhaseFlowEngineT {
+	public:
+	//same here if needed
+};
+
+typedef TemplateFlowEngine_TwoPhaseFlowEngineT<TwoPhaseCellInfo,TwoPhaseVertexInfo> TwoPhaseFlowEngineT;
+REGISTER_SERIALIZABLE(TwoPhaseFlowEngineT);
+
+class TwoPhaseFlowEngine : public TwoPhaseFlowEngineT
+{
+		double totalCellVolume;
+	public :
+	//We can overload every functions of the base engine to make it behave differently
+	//if we overload action() like this, this engine is doing nothing in a standard timestep, it can still have useful functions
+	virtual void action() {};
+	
+	//If a new function is specific to the derived engine, put it here, else go to the base TemplateFlowEngine
+	//if it is useful for everyone
+	void fancyFunction(Real what);
+
+	YADE_CLASS_BASE_DOC_ATTRS_INIT_CTOR_PY(TwoPhaseFlowEngine,TwoPhaseFlowEngineT,"documentation here",
+	((double,surfaceTension,0.0728,,"Water Surface Tension in contact with air at 20 Degrees Celsius is: 0.0728(N/m)"))
+	((bool,initialWetting,true,,"Initial wetting saturated (=true) or non-wetting saturated (=false)"))
+	((bool, isPhaseTrapped,true,,"If True, both phases can be entrapped by the other, which would correspond to snap-off. If false, both phases are always connected to their reservoirs, thus no snap-off."))
+	
+	,/*TwoPhaseFlowEngineT()*/,
+	,
+	.def("fancyFunction",&TwoPhaseFlowEngine::fancyFunction,(boost::python::arg("what")=0),"test function")
+	)
+	DECLARE_LOGGER;
+};
+REGISTER_SERIALIZABLE(TwoPhaseFlowEngine);
+
+#endif //TwoPhaseFLOW
+