1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
|
#pragma once
#include <lib/serialization/Serializable.hpp>
// keep those two here, template instantiation & boost::python gets broken otherwise, e.g. (old site, fixed bug) https://bugs.launchpad.net/bugs/618766
#include <core/Body.hpp>
#include <core/IGeom.hpp>
#include <core/IPhys.hpp>
namespace yade { // Cannot have #include directive inside.
class IGeomFunctor;
class IPhysFunctor;
class LawFunctor;
class Scene;
class Interaction : public Serializable {
private:
friend class IPhysDispatcher;
friend class InteractionLoop;
public:
bool isReal() const { return (bool)geom && (bool)phys; }
//! If this interaction was just created in this step (for the constitutive law, to know that it is the first time there)
bool isFresh(Scene* rb);
// FIXME - it is set to true, and never set to false. What is the purpose to have it? just try: grep -E "\<isActive\>" . -rn --include='*pp' --color
// It looks like it can be removed, after stable release.
bool isActive;
Interaction(Body::id_t newId1, Body::id_t newId2);
const Body::id_t& getId1() const { return id1; };
const Body::id_t& getId2() const { return id2; };
//! swaps order of bodies within the interaction
void swapOrder();
bool operator<(const Interaction& other) const { return getId1() < other.getId1() || (getId1() == other.getId1() && getId2() < other.getId2()); }
//! cache functors that are called for this interaction. Currently used by InteractionLoop.
struct {
// Whether geometry dispatcher exists at all; this is different from !geom, since that can mean we haven't populated the cache yet.
// Therefore, geomExists must be initialized to true first (done in Interaction::reset() called from ctor).
bool geomExists;
shared_ptr<IGeomFunctor> geom = nullptr;
shared_ptr<IPhysFunctor> phys = nullptr;
shared_ptr<LawFunctor> constLaw = nullptr;
} functorCache;
//! Reset interaction to the intial state (keep only body ids)
void reset();
//! common initialization called from both constructor and reset()
void init();
::boost::python::dict pyDictCustom() const override
{
::boost::python::dict ret;
ret["isReal"] = ::boost::python::object(isReal());
return ret;
}
// clang-format off
YADE_CLASS_BASE_DOC_ATTRS_CTOR_PY(Interaction,Serializable,"Interaction between pair of bodies.",
((Body::id_t,id1,0,Attr::readonly,":yref:`Id<Body::id>` of the first body in this interaction."))
((Body::id_t,id2,0,Attr::readonly,":yref:`Id<Body::id>` of the second body in this interaction."))
((long,iterMadeReal,-1,,"Step number at which the interaction was fully (in the sense of geom and phys) created. (Should be touched only by :yref:`IPhysDispatcher` and :yref:`InteractionLoop`, therefore they are made friends of Interaction"))
((long,iterLastSeen,-1,(Attr::noSave|Attr::hidden),"At which step this interaction was last detected by the collider. InteractionLoop will remove it if InteractionContainer::iterColliderLastRun==scene->iter, InteractionContainer::iterColliderLastRun is positive (some colliders manage interaction deletion themselves, such as :yref:`InsertionSortCollider`) and iterLastSeen<scene->iter."))
((shared_ptr<IGeom>,geom,,,"Geometry part of the interaction."))
((shared_ptr<IPhys>,phys,,,"Physical (material) part of the interaction."))
((Vector3i,cellDist,Vector3i(0,0,0),,"Distance of bodies in cell size units, if using periodic boundary conditions; id2 is shifted by this number of cells from its :yref:`State::pos` coordinates for this interaction to exist. Assigned by the collider.\n\n.. warning::\n\t(internal) cellDist must survive Interaction::reset(), it is only initialized in ctor. Interaction that was cancelled by the constitutive law, was reset() and became only potential must have the period information if the geometric functor again makes it real. Good to know after few days of debugging that :-)"))
((int,linIx,-1,(Attr::noSave|Attr::hidden),"Index in the linear interaction container. For internal use by InteractionContainer only."))
((long,iterBorn,-1,,"Step number at which the interaction was added to simulation."))
,
/* ctor */ init(),
/*py*/
.def_readonly("isReal",&Interaction::isReal,"True if this interaction has both :yref:`geom<Interaction.geom>` and :yref:`phys<Interaction.phys>`; False otherwise. :yattrflags:`2` ")
.def_readwrite("isActive",&Interaction::isActive,"True if this interaction is active. Otherwise the forces from this interaction will not be taken into account. True by default.")
);
// clang-format on
};
REGISTER_SERIALIZABLE(Interaction);
} // namespace yade
|
