------------------------------------------------------------ revno: 4178 committer: jduriez <[email protected]> timestamp: Wed 2014-10-01 11:33:13 -0600 message: Typos and precisions in capillary doc modified: pkg/dem/CapillaryPhys.hpp pkg/dem/HertzMindlin.hpp pkg/dem/Law2_ScGeom_CapillaryPhys_Capillarity.hpp
-- 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/dem/CapillaryPhys.hpp' --- pkg/dem/CapillaryPhys.hpp 2014-09-19 16:32:34 +0000 +++ pkg/dem/CapillaryPhys.hpp 2014-10-01 17:33:13 +0000 @@ -20,8 +20,8 @@ YADE_CLASS_BASE_DOC_ATTRS_DEPREC_INIT_CTOR_PY(CapillaryPhys,FrictPhys,"Physics (of interaction) for :yref:`Law2_ScGeom_CapillaryPhys_Capillarity`.", ((bool,meniscus,false,,"Presence of a meniscus if true")) ((bool,isBroken,false,,"If true, capillary force is zero and liquid bridge is inactive.")) - ((Real,capillaryPressure,0.,,"Value of the capillary pressure Uc defines as Ugas-Uliquid")) - ((Real,vMeniscus,0.,,"Volume of the menicus")) + ((Real,capillaryPressure,0.,,"Value of the capillary pressure Uc. Defined as Ugas-Uliquid, obtained from :yref:`corresponding Law2 parameter<Law2_ScGeom_CapillaryPhys_Capillarity.capillaryPressure>`")) + ((Real,vMeniscus,0.,,"Volume of the meniscus")) ((Real,Delta1,0.,,"Defines the surface area wetted by the meniscus on the smallest grains of radius R1 (R1<R2)")) ((Real,Delta2,0.,,"Defines the surface area wetted by the meniscus on the biggest grains of radius R2 (R1<R2)")) ((Vector3r,fCap,Vector3r::Zero(),,"Capillary Force produces by the presence of the meniscus")) === modified file 'pkg/dem/HertzMindlin.hpp' --- pkg/dem/HertzMindlin.hpp 2014-07-23 09:07:11 +0000 +++ pkg/dem/HertzMindlin.hpp 2014-10-01 17:33:13 +0000 @@ -181,8 +181,8 @@ YADE_CLASS_BASE_DOC_ATTRS_DEPREC_INIT_CTOR_PY(MindlinCapillaryPhys,MindlinPhys,"Adds capillary physics to Mindlin's interaction physics.", ((bool,meniscus,false,,"Presence of a meniscus if true")) ((bool,isBroken,false,,"If true, capillary force is zero and liquid bridge is inactive.")) - ((Real,capillaryPressure,0.,,"Value of the capillary pressure Uc defines as Ugas-Uliquid")) - ((Real,vMeniscus,0.,,"Volume of the menicus")) + ((Real,capillaryPressure,0.,,"Value of the capillary pressure Uc. Defined as Ugas-Uliquid, obtained from :yref:`corresponding Law2 parameter<Law2_ScGeom_CapillaryPhys_Capillarity.capillaryPressure>`")) + ((Real,vMeniscus,0.,,"Volume of the meniscus")) ((Real,Delta1,0.,,"Defines the surface area wetted by the meniscus on the smallest grains of radius R1 (R1<R2)")) ((Real,Delta2,0.,,"Defines the surface area wetted by the meniscus on the biggest grains of radius R2 (R1<R2)")) ((Vector3r,fCap,Vector3r::Zero(),,"Capillary Force produces by the presence of the meniscus")) === modified file 'pkg/dem/Law2_ScGeom_CapillaryPhys_Capillarity.hpp' --- pkg/dem/Law2_ScGeom_CapillaryPhys_Capillarity.hpp 2014-09-19 16:32:34 +0000 +++ pkg/dem/Law2_ScGeom_CapillaryPhys_Capillarity.hpp 2014-10-01 17:33:13 +0000 @@ -86,7 +86,7 @@ void postLoad(Law2_ScGeom_CapillaryPhys_Capillarity&); YADE_CLASS_BASE_DOC_ATTRS_DEPREC_INIT_CTOR_PY(Law2_ScGeom_CapillaryPhys_Capillarity,GlobalEngine,"This law allows one to take into account capillary forces/effects between spheres coming from the presence of interparticular liquid bridges (menisci).\n\nThe control parameter is the :yref:`capillary pressure<Law2_ScGeom_CapillaryPhys_Capillarity::capillaryPressure>` (or suction) Uc = Ugas - Uliquid. Liquid bridges properties (volume V, extent over interacting grains delta1 and delta2) are computed as a result of the defined capillary pressure and of the interacting geometry (spheres radii and interparticular distance).\n\nReferences: in english [Scholtes2009b]_; more detailed, but in french [Scholtes2009d]_.\n\nThe law needs ascii files M(r=i) with i=R1/R2 to work (see https://yade-dem.org/wiki/CapillaryTriaxialTest). These ASCII files contain a set of results from the resolution of the Laplace-Young equation for different configurations of the interacting geometry, assuming a null wetting angle.\n\nIn order to allow capillary forces between distant spheres, it is necessary to enlarge the bounding boxes using :yref:`Bo1_Sphere_Aabb::aabbEnlargeFactor` and make the Ig2 define define distant interactions via :yref:`interactionDetectionFactor<Ig2_Sphere_Sphere_ScGeom::interactionDetectionFactor>`. It is also necessary to disable interactions removal by the constitutive law (:yref:`Law2<Law2_ScGeom_FrictPhys_CundallStrack::neverErase>=True`). The only combinations of laws supported are currently capillary law + :yref:`Law2_ScGeom_FrictPhys_CundallStrack` and capillary law + :yref:`Law2_ScGeom_MindlinPhys_Mindlin` (and the other variants of Hertz-Mindlin).\n\nSee CapillaryPhys-example.py for an example script.", - ((Real,capillaryPressure,0.,,"Value of the capillary pressure Uc defines as Uc=Ugas-Uliquid")) + ((Real,capillaryPressure,0.,,"Value of the capillary pressure Uc defined as Uc=Ugas-Uliquid")) ((bool,fusionDetection,false,,"If true potential menisci overlaps are checked")) ((bool,binaryFusion,true,,"If true, capillary forces are set to zero as soon as, at least, 1 overlap (menisci fusion) is detected")) ((bool,hertzOn,false,,"|yupdate| true if hertz model is used"))
_______________________________________________ Mailing list: https://launchpad.net/~yade-dev Post to : [email protected] Unsubscribe : https://launchpad.net/~yade-dev More help : https://help.launchpad.net/ListHelp

