chrono::vehicle::SCMDeformableSoil Class Reference
  Description
Underlying implementation of the Soil Contact Model.
#include <SCMDeformableTerrain.h>
Inheritance diagram for chrono::vehicle::SCMDeformableSoil:

Collaboration diagram for chrono::vehicle::SCMDeformableSoil:

| Public Member Functions | |
| SCMDeformableSoil (ChSystem *system, bool visualization_mesh) | |
| void | Initialize (double hsizeX, double hsizeY, double delta) | 
| Initialize the terrain system (flat).  More... | |
| void | Initialize (const std::string &heightmap_file, double sizeX, double sizeY, double hMin, double hMax, double delta) | 
| Initialize the terrain system (height map).  More... | |
| void | Initialize (const std::string &mesh_file, double delta) | 
| Initialize the terrain system (mesh).  More... | |
|  Public Member Functions inherited from chrono::ChLoadContainer | |
| ChLoadContainer (const ChLoadContainer &other) | |
| virtual ChLoadContainer * | Clone () const override | 
| "Virtual" copy constructor (covariant return type). | |
| void | Add (std::shared_ptr< ChLoadBase > newload) | 
| Add a load to the container list of loads.  More... | |
| std::vector< std::shared_ptr< ChLoadBase > > & | GetLoadList () | 
| Direct access to the load vector. | |
| size_t | GetNumLoads () const | 
| Return the number of loads in this container. | |
| virtual void | IntLoadResidual_Mv (const unsigned int off, ChVectorDynamic<> &R, const ChVectorDynamic<> &w, const double c) override | 
| Takes the M*v term, multiplying mass by a vector, scale and adds to R at given offset: R += c*M*w.  More... | |
| virtual void | InjectKRMmatrices (ChSystemDescriptor &mdescriptor) override | 
| Tell to a system descriptor that there are items of type ChKblock in this object (for further passing it to a solver) Basically does nothing, but maybe that inherited classes may specialize this. | |
| virtual void | KRMmatricesLoad (double Kfactor, double Rfactor, double Mfactor) override | 
| Adds the current stiffness K and damping R and mass M matrices in encapsulated ChKblock item(s), if any.  More... | |
| virtual void | ArchiveOUT (ChArchiveOut &marchive) override | 
| Method to allow serialization of transient data to archives. | |
| virtual void | ArchiveIN (ChArchiveIn &marchive) override | 
| Method to allow deserialization of transient data from archives. | |
|  Public Member Functions inherited from chrono::ChPhysicsItem | |
| ChPhysicsItem (const ChPhysicsItem &other) | |
| ChSystem * | GetSystem () const | 
| Get the pointer to the parent ChSystem(). | |
| virtual void | SetSystem (ChSystem *m_system) | 
| Set the pointer to the parent ChSystem().  More... | |
| void | AddVisualModel (std::shared_ptr< ChVisualModel > model) | 
| Add an (optional) visualization model.  More... | |
| std::shared_ptr< ChVisualModel > | GetVisualModel () const | 
| Access the visualization model (if any).  More... | |
| void | AddVisualShape (std::shared_ptr< ChVisualShape > shape, const ChFrame<> &frame=ChFrame<>()) | 
| Add the specified visual shape to the visualization model.  More... | |
| std::shared_ptr< ChVisualShape > | GetVisualShape (unsigned int i) const | 
| Access the specified visualization shape in the visualization model (if any).  More... | |
| void | AddVisualShapeFEA (std::shared_ptr< ChVisualShapeFEA > shapeFEA) | 
| Add the specified FEA visualization object to the visualization model.  More... | |
| std::shared_ptr< ChVisualShapeFEA > | GetVisualShapeFEA (unsigned int i) const | 
| Access the specified FEA visualization object in the visualization model (if any).  More... | |
| virtual ChFrame | GetVisualModelFrame (unsigned int nclone=0) | 
| Get the reference frame (expressed in and relative to the absolute frame) of the visual model.  More... | |
| virtual unsigned int | GetNumVisualModelClones () const | 
| Return the number of clones of the visual model associated with this physics item.  More... | |
| void | AddCamera (std::shared_ptr< ChCamera > camera) | 
| Attach a ChCamera to this physical item.  More... | |
| std::vector< std::shared_ptr< ChCamera > > | GetCameras () const | 
| Get the set of cameras attached to this physics item. | |
| virtual bool | IsActive () const | 
| Return true if the object is active and included in dynamics. | |
| virtual bool | GetCollide () const | 
| Tell if the object is subject to collision.  More... | |
| virtual void | SyncCollisionModels () | 
| If this physical item contains one or more collision models, synchronize their coordinates and bounding boxes to the state of the item. | |
| virtual void | AddCollisionModelsToSystem () | 
| If this physical item contains one or more collision models, add them to the system's collision engine. | |
| virtual void | RemoveCollisionModelsFromSystem () | 
| If this physical item contains one or more collision models, remove them from the system's collision engine. | |
| virtual void | GetTotalAABB (ChVector<> &bbmin, ChVector<> &bbmax) | 
| Get the entire AABB axis-aligned bounding box of the object.  More... | |
| virtual void | GetCenter (ChVector<> &mcenter) | 
| Get a symbolic 'center' of the object.  More... | |
| virtual void | StreamINstate (ChStreamInBinary &mstream) | 
| Method to deserialize only the state (position, speed) Must be implemented by child classes. | |
| virtual void | StreamOUTstate (ChStreamOutBinary &mstream) | 
| Method to serialize only the state (position, speed) Must be implemented by child classes. | |
| virtual void | Update (bool update_assets=true) | 
| As above, but does not require updating of time-dependent data.  More... | |
| virtual void | SetNoSpeedNoAcceleration () | 
| Set zero speed (and zero accelerations) in state, without changing the position.  More... | |
| virtual int | GetDOF () | 
| Get the number of scalar coordinates (variables), if any, in this item.  More... | |
| virtual int | GetDOF_w () | 
| Get the number of scalar coordinates of variables derivatives (usually = DOF, but might be different than DOF, ex.  More... | |
| virtual int | GetDOC () | 
| Get the number of scalar constraints, if any, in this item. | |
| virtual int | GetDOC_c () | 
| Get the number of scalar constraints, if any, in this item (only bilateral constr.) Children classes might override this. | |
| virtual int | GetDOC_d () | 
| Get the number of scalar constraints, if any, in this item (only unilateral constr.) Children classes might override this. | |
| unsigned int | GetOffset_x () | 
| Get offset in the state vector (position part) | |
| unsigned int | GetOffset_w () | 
| Get offset in the state vector (speed part) | |
| unsigned int | GetOffset_L () | 
| Get offset in the lagrangian multipliers. | |
| void | SetOffset_x (const unsigned int moff) | 
| Set offset in the state vector (position part) Note: only the ChSystem::Setup function should use this. | |
| void | SetOffset_w (const unsigned int moff) | 
| Set offset in the state vector (speed part) Note: only the ChSystem::Setup function should use this. | |
| void | SetOffset_L (const unsigned int moff) | 
| Set offset in the lagrangian multipliers Note: only the ChSystem::Setup function should use this. | |
| virtual void | IntStateGather (const unsigned int off_x, ChState &x, const unsigned int off_v, ChStateDelta &v, double &T) | 
| From item's state to global state vectors y={x,v} pasting the states at the specified offsets.  More... | |
| virtual void | IntStateScatter (const unsigned int off_x, const ChState &x, const unsigned int off_v, const ChStateDelta &v, const double T, bool full_update) | 
| From global state vectors y={x,v} to item's state (and update) fetching the states at the specified offsets.  More... | |
| virtual void | IntStateGatherAcceleration (const unsigned int off_a, ChStateDelta &a) | 
| From item's state acceleration to global acceleration vector.  More... | |
| virtual void | IntStateScatterAcceleration (const unsigned int off_a, const ChStateDelta &a) | 
| From global acceleration vector to item's state acceleration.  More... | |
| virtual void | IntStateGatherReactions (const unsigned int off_L, ChVectorDynamic<> &L) | 
| From item's reaction forces to global reaction vector.  More... | |
| virtual void | IntStateScatterReactions (const unsigned int off_L, const ChVectorDynamic<> &L) | 
| From global reaction vector to item's reaction forces.  More... | |
| virtual void | IntStateIncrement (const unsigned int off_x, ChState &x_new, const ChState &x, const unsigned int off_v, const ChStateDelta &Dv) | 
| Computes x_new = x + Dt , using vectors at specified offsets.  More... | |
| virtual void | IntStateGetIncrement (const unsigned int off_x, const ChState &x_new, const ChState &x, const unsigned int off_v, ChStateDelta &Dv) | 
| Computes Dt = x_new - x, using vectors at specified offsets.  More... | |
| virtual void | IntLoadResidual_CqL (const unsigned int off_L, ChVectorDynamic<> &R, const ChVectorDynamic<> &L, const double c) | 
| Takes the term Cq'*L, scale and adds to R at given offset: R += c*Cq'*L.  More... | |
| virtual void | IntLoadConstraint_C (const unsigned int off, ChVectorDynamic<> &Qc, const double c, bool do_clamp, double recovery_clamp) | 
| Takes the term C, scale and adds to Qc at given offset: Qc += c*C.  More... | |
| virtual void | IntLoadConstraint_Ct (const unsigned int off, ChVectorDynamic<> &Qc, const double c) | 
| Takes the term Ct, scale and adds to Qc at given offset: Qc += c*Ct.  More... | |
| virtual void | IntToDescriptor (const unsigned int off_v, const ChStateDelta &v, const ChVectorDynamic<> &R, const unsigned int off_L, const ChVectorDynamic<> &L, const ChVectorDynamic<> &Qc) | 
| Prepare variables and constraints to accommodate a solution:  More... | |
| virtual void | IntFromDescriptor (const unsigned int off_v, ChStateDelta &v, const unsigned int off_L, ChVectorDynamic<> &L) | 
| After a solver solution, fetch values from variables and constraints into vectors:  More... | |
| virtual void | VariablesFbReset () | 
| Sets the 'fb' part (the known term) of the encapsulated ChVariables to zero. | |
| virtual void | VariablesFbLoadForces (double factor=1) | 
| Adds the current forces (applied to item) into the encapsulated ChVariables, in the 'fb' part: qf+=forces*factor. | |
| virtual void | VariablesQbLoadSpeed () | 
| Initialize the 'qb' part of the ChVariables with the current value of speeds.  More... | |
| virtual void | VariablesFbIncrementMq () | 
| Adds M*q (masses multiplied current 'qb') to Fb, ex.  More... | |
| virtual void | VariablesQbSetSpeed (double step=0) | 
| Fetches the item speed (ex.  More... | |
| virtual void | VariablesQbIncrementPosition (double step) | 
| Increment item positions by the 'qb' part of the ChVariables, multiplied by a 'step' factor.  More... | |
| virtual void | InjectVariables (ChSystemDescriptor &mdescriptor) | 
| Tell to a system descriptor that there are variables of type ChVariables in this object (for further passing it to a solver) Basically does nothing, but maybe that inherited classes may specialize this. | |
| virtual void | InjectConstraints (ChSystemDescriptor &mdescriptor) | 
| Tell to a system descriptor that there are constraints of type ChConstraint in this object (for further passing it to a solver) Basically does nothing, but maybe that inherited classes may specialize this. | |
| virtual void | ConstraintsBiReset () | 
| Sets to zero the known term (b_i) of encapsulated ChConstraints. | |
| virtual void | ConstraintsBiLoad_C (double factor=1, double recovery_clamp=0.1, bool do_clamp=false) | 
| Adds the current C (constraint violation) to the known term (b_i) of encapsulated ChConstraints. | |
| virtual void | ConstraintsBiLoad_Ct (double factor=1) | 
| Adds the current Ct (partial t-derivative, as in C_dt=0-> [Cq]*q_dt=-Ct) to the known term (b_i) of encapsulated ChConstraints. | |
| virtual void | ConstraintsBiLoad_Qc (double factor=1) | 
| Adds the current Qc (the vector of C_dtdt=0 -> [Cq]*q_dtdt=Qc ) to the known term (b_i) of encapsulated ChConstraints. | |
| virtual void | ConstraintsFbLoadForces (double factor=1) | 
| Adds the current link-forces, if any, (caused by springs, etc.) to the 'fb' vectors of the ChVariables referenced by encapsulated ChConstraints. | |
| virtual void | ConstraintsLoadJacobians () | 
| Adds the current jacobians in encapsulated ChConstraints. | |
| virtual void | ConstraintsFetch_react (double factor=1) | 
| Fetches the reactions from the lagrangian multiplier (l_i) of encapsulated ChConstraints.  More... | |
|  Public Member Functions inherited from chrono::ChObj | |
| ChObj (const ChObj &other) | |
| int | GetIdentifier () const | 
| Gets the numerical identifier of the object. | |
| void | SetIdentifier (int id) | 
| Sets the numerical identifier of the object. | |
| double | GetChTime () const | 
| Gets the simulation time of this object. | |
| void | SetChTime (double m_time) | 
| Sets the simulation time of this object. | |
| const char * | GetName () const | 
| Gets the name of the object as C Ascii null-terminated string -for reading only! | |
| void | SetName (const char myname[]) | 
| Sets the name of this object, as ascii string. | |
| std::string | GetNameString () const | 
| Gets the name of the object as C Ascii null-terminated string. | |
| void | SetNameString (const std::string &myname) | 
| Sets the name of this object, as std::string. | |
| void | MFlagsSetAllOFF (int &mflag) | 
| void | MFlagsSetAllON (int &mflag) | 
| void | MFlagSetON (int &mflag, int mask) | 
| void | MFlagSetOFF (int &mflag, int mask) | 
| int | MFlagGet (int &mflag, int mask) | 
| virtual std::string & | ArchiveContainerName () | 
| Friends | |
| class | SCMDeformableTerrain | 
| Additional Inherited Members | |
|  Protected Attributes inherited from chrono::ChPhysicsItem | |
| ChSystem * | system | 
| parent system | |
| std::shared_ptr< ChVisualModelInstance > | vis_model_instance | 
| instantiated visualization model | |
| std::vector< std::shared_ptr< ChCamera > > | cameras | 
| set of cameras | |
| unsigned int | offset_x | 
| offset in vector of state (position part) | |
| unsigned int | offset_w | 
| offset in vector of state (speed part) | |
| unsigned int | offset_L | 
| offset in vector of lagrangian multipliers | |
|  Protected Attributes inherited from chrono::ChObj | |
| double | ChTime | 
| the time of simulation for the object | |
Member Function Documentation
◆ Initialize() [1/3]
| void chrono::vehicle::SCMDeformableSoil::Initialize | ( | const std::string & | heightmap_file, | 
| double | sizeX, | ||
| double | sizeY, | ||
| double | hMin, | ||
| double | hMax, | ||
| double | delta | ||
| ) | 
Initialize the terrain system (height map).
The initial undeformed mesh is provided via the specified image file as a height map.
- Parameters
- 
  [in] heightmap_file filename for the height map (image file) [in] sizeX terrain dimension in the X direction [in] sizeY terrain dimension in the Y direction [in] hMin minimum height (black level) [in] hMax maximum height (white level) [in] delta grid spacing (may be slightly decreased) 
◆ Initialize() [2/3]
| void chrono::vehicle::SCMDeformableSoil::Initialize | ( | const std::string & | mesh_file, | 
| double | delta | ||
| ) | 
Initialize the terrain system (mesh).
The initial undeformed terrain profile is provided via the specified Wavefront OBJ mesh file.
- Parameters
- 
  [in] mesh_file filename for the height map (image file) [in] delta grid spacing (may be slightly decreased) 
◆ Initialize() [3/3]
| void chrono::vehicle::SCMDeformableSoil::Initialize | ( | double | hsizeX, | 
| double | hsizeY, | ||
| double | delta | ||
| ) | 
Initialize the terrain system (flat).
This version creates a flat array of points.
- Parameters
- 
  [in] hsizeX terrain dimension in the X direction [in] hsizeY terrain dimension in the Y direction [in] delta grid spacing (may be slightly decreased) 
The documentation for this class was generated from the following files:
- /builds/uwsbel/chrono/src/chrono_vehicle/terrain/SCMDeformableTerrain.h
- /builds/uwsbel/chrono/src/chrono_vehicle/terrain/SCMDeformableTerrain.cpp
