PeriDyno 1.0.0
Loading...
Searching...
No Matches
dyno::GranularMedia< TDataType > Class Template Reference

This class implements the shallow sand equation to simulate dry granular flows. For more details, refer to "Shallow Sand Equations: Real-Time Height Field Simulation of Dry Granular Flows" by Zhu et al.[2021], IEEE TVCG. More...

#include <GranularMedia.h>

Inheritance diagram for dyno::GranularMedia< TDataType >:
Collaboration diagram for dyno::GranularMedia< TDataType >:

Public Types

typedef TDataType::Real Real
 
typedef ::dyno::Vector< Real, 3 > Coord3D
 
typedef ::dyno::Vector< Real, 4 > Coord4D
 
- Public Types inherited from dyno::Node
template<class T>
using SPtr = std::shared_ptr<T>
 
- Public Types inherited from dyno::OBase
typedef std::vector< FBase * > FieldVector
 
typedef std::map< FieldID, FBase * > FieldMap
 

Public Member Functions

 GranularMedia ()
 
 ~GranularMedia ()
 
 DEF_VAR (Coord3D, Origin, Coord3D(0), "")
 
 DEF_VAR (uint, Width, 64, "")
 
 DEF_VAR (uint, Height, 64, "")
 
 DEF_VAR (Real, Depth, 1.0f, "Depth")
 
 DEF_VAR (Real, DepthOfDiluteLayer, 0.7f, "Depth of the dilute layer")
 
 DEF_VAR (Real, CoefficientOfDragForce, 0.7f, "The drag force coefficient")
 
 DEF_VAR (Real, CoefficientOfFriction, 0.95f, "The frictional coefficient exerted on the dilute layer")
 
 DEF_VAR (Real, Spacing, 1, "Grid spacing")
 
 DEF_VAR (Real, Gravity, -9.8, "")
 
 DEF_ARRAY2D_STATE (Real, LandScape, DeviceType::GPU, "")
 
 DEF_ARRAY2D_STATE (Coord4D, Grid, DeviceType::GPU, "")
 
 DEF_ARRAY2D_STATE (Coord4D, GridNext, DeviceType::GPU, "")
 
 DEF_INSTANCE_STATE (HeightField< TDataType >, HeightField, "Topology")
 
- Public Member Functions inherited from dyno::Node
 Node ()
 
 ~Node () override
 
void setName (std::string name)
 
std::string getName () override
 
virtual std::string getNodeType ()
 
bool isAutoSync ()
 
bool isAutoHidden ()
 
void setAutoSync (bool con)
 Whether the node can be automatically synchronized when its ancestor is updated.
 
void setAutoHidden (bool con)
 
virtual bool isActive ()
 Check the state of dynamics.
 
virtual void setActive (bool active)
 Set the state of dynamics.
 
virtual bool isVisible ()
 Check the visibility of context.
 
virtual void setVisible (bool visible)
 Set the visibility of context.
 
virtual Real getDt ()
 Simulation timestep.
 
void setDt (Real dt)
 
void setSceneGraph (SceneGraph *scn)
 
SceneGraphgetSceneGraph ()
 
std::vector< NodePort * > & getImportNodes ()
 
std::vector< NodePort * > & getExportNodes ()
 
bool addModule (std::shared_ptr< Module > module)
 Add a module to m_module_list and other special module lists.
 
bool deleteModule (std::shared_ptr< Module > module)
 
template<class TModule>
bool addModule (std::shared_ptr< TModule > tModule)
 Add a speical kind of module.
 
template<class TModule>
bool deleteModule (std::shared_ptr< TModule > tModule)
 
std::list< std::shared_ptr< Module > > & getModuleList ()
 
bool hasModule (std::string name)
 
std::shared_ptr< ModulegetModule (std::string name)
 Get a module by its name.
 
template<class TModule>
std::shared_ptr< TModule > getModule ()
 Get the Module by the module class name.
 
template<class TModule>
std::shared_ptr< TModule > getModule (std::string name)
 
std::shared_ptr< PipelineresetPipeline ()
 
std::shared_ptr< AnimationPipelineanimationPipeline ()
 
std::shared_ptr< GraphicsPipelinegraphicsPipeline ()
 
template<class TModule>
std::shared_ptr< TModule > addModule (std::string name)
 
void update ()
 Called every time interval.
 
void updateGraphicsContext ()
 
void reset ()
 
virtual NBoundingBox boundingBox ()
 
bool connect (NodePort *nPort)
 Depth-first tree traversal.
 
bool disconnect (NodePort *nPort)
 
bool attachField (FBase *field, std::string name, std::string desc, bool autoDestroy=true) override
 Attach a field to Node.
 
std::vector< NodePort * > & getAllNodePorts ()
 
uint sizeOfNodePorts ()
 
uint sizeOfImportNodes () const
 
uint sizeOfExportNodes () const
 
void setForceUpdate (bool b)
 
 DEF_VAR_STATE (Real, ElapsedTime, 0, "Elapsed Time")
 
 DEF_VAR_STATE (Real, TimeStep, Real(0.033), "Time step size")
 
 DEF_VAR_STATE (uint, FrameNumber, 0, "Frame number")
 
- Public Member Functions inherited from dyno::OBase
 OBase ()
 
 ~OBase () override
 
virtual std::string caption ()
 Return the caption.
 
virtual bool captionVisible ()
 Whether to hide the caption in the GUI.
 
virtual std::string description ()
 Return a description for the node or module, override this function to support user-defined description.
 
bool addField (FBase *data)
 Add a field to Base FieldID will be set to the name of Field by default.
 
bool addField (FieldID name, FBase *data)
 Add a field to Base.
 
bool addFieldAlias (FieldID name, FBase *data)
 
bool addFieldAlias (FieldID name, FBase *data, FieldMap &fieldAlias)
 
bool findField (FBase *data)
 Find a field by its pointer.
 
bool findFieldAlias (const FieldID name)
 Find a field by its name.
 
bool findFieldAlias (const FieldID name, FieldMap &fieldAlias)
 Find a field in fieldAlias by its name This function is typically called by other functions.
 
bool removeField (FBase *data)
 Remove a field by its pointer.
 
bool removeFieldAlias (const FieldID name)
 Remove a field by its name.
 
bool removeFieldAlias (const FieldID name, FieldMap &fieldAlias)
 
FBasegetField (const FieldID name)
 Return a field by its name.
 
std::vector< FBase * > & getAllFields ()
 
template<typename T>
TgetField (FieldID name)
 
bool isAllFieldsReady ()
 Check the completeness of all required fields.
 
std::vector< FieldIDgetFieldAlias (FBase *data)
 
int getFieldAliasCount (FBase *data)
 
void setBlockCoord (float x, float y)
 
float bx ()
 
float by ()
 
bool findInputField (FBase *field)
 
bool addInputField (FBase *field)
 
bool removeInputField (FBase *field)
 
std::vector< FBase * > & getInputFields ()
 
bool findOutputField (FBase *field)
 
bool addOutputField (FBase *field)
 
bool addToOutput (FBase *field)
 
bool removeOutputField (FBase *field)
 
bool removeFromOutput (FBase *field)
 
std::vector< FBase * > & getOutputFields ()
 
bool findParameter (FBase *field)
 
bool addParameter (FBase *field)
 
bool removeParameter (FBase *field)
 
std::vector< FBase * > & getParameters ()
 
- Public Member Functions inherited from dyno::Object
 Object ()
 
virtual ~Object ()
 
ObjectId objectId ()
 

Protected Member Functions

void resetStates () override
 
void updateStates () override
 
- Protected Member Functions inherited from dyno::Node
bool appendExportNode (NodePort *nodePort)
 
bool removeExportNode (NodePort *nodePort)
 
virtual void preUpdateStates ()
 
virtual void postUpdateStates ()
 
virtual void updateTopology ()
 
virtual bool validateInputs ()
 
virtual bool requireUpdate ()
 
void tick ()
 notify all state and output fields are updated
 

Additional Inherited Members

- Static Public Member Functions inherited from dyno::Object
static bool registerClass (ClassInfo *ci)
 
static ObjectcreateObject (std::string name)
 
static std::map< std::string, ClassInfo * > * getClassMap ()
 
static ObjectId baseId ()
 Base Id.
 
- Public Attributes inherited from dyno::Node
std::string m_node_name
 
- Protected Attributes inherited from dyno::OBase
std::vector< FBase * > fields_input
 
std::vector< FBase * > fields_output
 
std::vector< FBase * > fields_param
 

Detailed Description

template<typename TDataType>
class dyno::GranularMedia< TDataType >

This class implements the shallow sand equation to simulate dry granular flows. For more details, refer to "Shallow Sand Equations: Real-Time Height Field Simulation of Dry Granular Flows" by Zhu et al.[2021], IEEE TVCG.

Definition at line 30 of file GranularMedia.h.

Member Typedef Documentation

◆ Coord3D

template<typename TDataType>
typedef ::dyno::Vector<Real, 3> dyno::GranularMedia< TDataType >::Coord3D

Definition at line 35 of file GranularMedia.h.

◆ Coord4D

template<typename TDataType>
typedef ::dyno::Vector<Real, 4> dyno::GranularMedia< TDataType >::Coord4D

Definition at line 36 of file GranularMedia.h.

◆ Real

template<typename TDataType>
typedef TDataType::Real dyno::GranularMedia< TDataType >::Real

Definition at line 34 of file GranularMedia.h.

Constructor & Destructor Documentation

◆ GranularMedia()

template<typename TDataType>
dyno::GranularMedia< TDataType >::GranularMedia ( )

◆ ~GranularMedia()

template<typename TDataType>
dyno::GranularMedia< TDataType >::~GranularMedia ( )

Member Function Documentation

◆ DEF_ARRAY2D_STATE() [1/3]

template<typename TDataType>
dyno::GranularMedia< TDataType >::DEF_ARRAY2D_STATE ( Coord4D ,
Grid ,
DeviceType::GPU ,
""  )

◆ DEF_ARRAY2D_STATE() [2/3]

template<typename TDataType>
dyno::GranularMedia< TDataType >::DEF_ARRAY2D_STATE ( Coord4D ,
GridNext ,
DeviceType::GPU ,
""  )

◆ DEF_ARRAY2D_STATE() [3/3]

template<typename TDataType>
dyno::GranularMedia< TDataType >::DEF_ARRAY2D_STATE ( Real ,
LandScape ,
DeviceType::GPU ,
""  )

◆ DEF_INSTANCE_STATE()

template<typename TDataType>
dyno::GranularMedia< TDataType >::DEF_INSTANCE_STATE ( HeightField< TDataType > ,
HeightField ,
"Topology"  )

◆ DEF_VAR() [1/9]

template<typename TDataType>
dyno::GranularMedia< TDataType >::DEF_VAR ( Coord3D ,
Origin ,
Coord3D(0) ,
""  )

◆ DEF_VAR() [2/9]

template<typename TDataType>
dyno::GranularMedia< TDataType >::DEF_VAR ( Real ,
CoefficientOfDragForce ,
0. 7f,
"The drag force coefficient"  )

◆ DEF_VAR() [3/9]

template<typename TDataType>
dyno::GranularMedia< TDataType >::DEF_VAR ( Real ,
CoefficientOfFriction ,
0. 95f,
"The frictional coefficient exerted on the dilute layer"  )

◆ DEF_VAR() [4/9]

template<typename TDataType>
dyno::GranularMedia< TDataType >::DEF_VAR ( Real ,
Depth ,
1. 0f,
"Depth"  )

◆ DEF_VAR() [5/9]

template<typename TDataType>
dyno::GranularMedia< TDataType >::DEF_VAR ( Real ,
DepthOfDiluteLayer ,
0. 7f,
"Depth of the dilute layer"  )

◆ DEF_VAR() [6/9]

template<typename TDataType>
dyno::GranularMedia< TDataType >::DEF_VAR ( Real ,
Gravity ,
-9. 8,
""  )

◆ DEF_VAR() [7/9]

template<typename TDataType>
dyno::GranularMedia< TDataType >::DEF_VAR ( Real ,
Spacing ,
1 ,
"Grid spacing"  )

◆ DEF_VAR() [8/9]

template<typename TDataType>
dyno::GranularMedia< TDataType >::DEF_VAR ( uint ,
Height ,
64 ,
""  )

◆ DEF_VAR() [9/9]

template<typename TDataType>
dyno::GranularMedia< TDataType >::DEF_VAR ( uint ,
Width ,
64 ,
""  )

◆ resetStates()

template<typename TDataType>
void dyno::GranularMedia< TDataType >::resetStates ( )
overrideprotectedvirtual

Reimplemented from dyno::Node.

◆ updateStates()

template<typename TDataType>
void dyno::GranularMedia< TDataType >::updateStates ( )
overrideprotectedvirtual

Reimplemented from dyno::Node.


The documentation for this class was generated from the following file: