### Setup Source: https://api.chrono.projectchrono.org/classchrono_1_1_ch_system_multicore-members.html Performs the setup operations required before starting the simulation. This is an override from the base ChSystem class. ```APIDOC ## Setup ### Description Performs necessary setup operations for the multibody system, typically called before simulation begins. This method is an override from the base `ChSystem` class. ### Method Signature `void Setup() override` ``` -------------------------------- ### Setup Source: https://api.chrono.projectchrono.org/classchrono_1_1_ch_particle_cloud-members.html Performs setup operations for the particle cloud, typically called before simulation starts. ```APIDOC ## Setup() ### Description Initializes and prepares the particle cloud for simulation. This method should be called before starting the physics simulation. ``` -------------------------------- ### Setup Source: https://api.chrono.projectchrono.org/classchrono_1_1particlefactory_1_1_ch_random_shape_creator_from_families.html Finalizes the setup after adding all samples. ```APIDOC ## void Setup() ### Description Call this when you finished adding samples via AddSample(). ``` -------------------------------- ### System Setup Source: https://api.chrono.projectchrono.org/classchrono_1_1fea_1_1_ch_node_f_e_afield_x_y_z.html Function for initial system setup. ```APIDOC ## System Setup ### SetupInitial - virtual void **SetupInitial** (ChSystem *system) Initial setup. ``` -------------------------------- ### SetupInitial Source: https://api.chrono.projectchrono.org/classchrono_1_1fea_1_1_ch_field_element_line.html Initial setup function, called once before the start of the simulation. ```APIDOC ## SetupInitial() ### Description Initial setup function, called once before the start of the simulation. ### Method `virtual void SetupInitial(ChSystem *system)` ### Parameters * **system** (ChSystem *) - Pointer to the Chrono system. ``` -------------------------------- ### Initial Setup Source: https://api.chrono.projectchrono.org/classchrono_1_1fea_1_1_ch_node_f_e_axyz_d.html Method for initial setup of the node. ```APIDOC ## SetupInitial ### Description Initial setup for the node. Sets the number of degrees of freedom. ### Parameters - **system** (ChSystem *) - Pointer to the Chrono system. ### Method Signature void SetupInitial(ChSystem *system) override ``` -------------------------------- ### Initial Setup Source: https://api.chrono.projectchrono.org/classchrono_1_1peridynamics_1_1_ch_node_peri.html Performs the initial setup for the node within the system. ```APIDOC ## SetupInitial ### Description Initial setup. ### Method `void SetupInitial(ChSystem *system)` ``` -------------------------------- ### Setup Source: https://api.chrono.projectchrono.org/classchrono_1_1_ch_iterative_solver_multicore_n_s_c.html Performs setup operations for the solver. ```APIDOC ## virtual bool Setup(ChSystemDescriptor &sysd, bool analyze) ### Description Perform setup operations for the solver. ### Parameters * **sysd** (ChSystemDescriptor &) - Required - The system descriptor. * **analyze** (bool) - Required - Whether to analyze the system during setup. ### Returns * bool - True if setup was successful, false otherwise. ``` -------------------------------- ### Setup Source: https://api.chrono.projectchrono.org/classchrono_1_1_ch_contact_container_s_m_c.html Perform setup operations. ```APIDOC ## Setup ### Description Perform setup operations. ### Method virtual void ### Endpoint Setup() ``` -------------------------------- ### Setup Source: https://api.chrono.projectchrono.org/classchrono_1_1_ch_solver_mumps.html Performs the necessary setup operations for the solver. ```APIDOC ## Setup(ChSystemDescriptor &sysd, bool analyze) ### Description Perform the solver setup operations. More... ### Parameters * **sysd** (ChSystemDescriptor &) - Required - The system descriptor containing system information. * **analyze** (bool) - Required - Whether to analyze the system during setup. ``` -------------------------------- ### Setup Source: https://api.chrono.projectchrono.org/classchrono_1_1_ch_particle_cloud.html Performs necessary setup operations for the particle cloud. ```APIDOC ## Setup ### Description Perform setup operations. ### Method virtual void ``` -------------------------------- ### Setup Source: https://api.chrono.projectchrono.org/classchrono_1_1fea_1_1_ch_f_e_model_impl.html Performs general setup operations for the model. ```APIDOC ## Setup() ### Description Perform setup operations. ### Returns void ``` -------------------------------- ### Setup Source: https://api.chrono.projectchrono.org/classchrono_1_1_ch_body_easy_box.html Performs setup operations for the physics item. ```APIDOC ## Setup ### Description Perform setup operations. ### Method virtual void ### Signature Setup() ``` -------------------------------- ### Setup Source: https://api.chrono.projectchrono.org/classchrono_1_1cascade_1_1_ch_body_easy_cascade_profile.html Performs setup operations for the object. ```APIDOC ## Setup ### Description Perform setup operations. ### Method virtual void Setup() ``` -------------------------------- ### Setup Source: https://api.chrono.projectchrono.org/classchrono_1_1_ch_body.html Performs setup operations for the physics item. ```APIDOC ## Setup ### Description Perform setup operations. ### Signature virtual void Setup() ``` -------------------------------- ### Setup Source: https://api.chrono.projectchrono.org/classchrono_1_1fea_1_1_ch_f_e_model_thermo_deformation.html Performs setup operations for the model. ```APIDOC ## Setup ### Description Perform setup operations. ### Method ```cpp virtual void Setup () override ``` ``` -------------------------------- ### Setup Source: https://api.chrono.projectchrono.org/classchrono_1_1_ch_contact_container_multicore.html Performs necessary setup operations for the physics item. ```APIDOC ## Setup ### Description Perform setup operations. ### Method `virtual void Setup()` ``` -------------------------------- ### Create Slider Guide for Linear Motors Source: https://api.chrono.projectchrono.org/tutorial_demo_motors.html Helper function to create a fixed guide body and a movable slider body. Used to simplify the setup for linear motor examples. ```C++ void CreateSliderGuide(std::shared_ptr& guide, std::shared_ptr& slider, std::shared_ptr material, ChSystem* sys, const ChVector3d mpos) { guide = chrono_types::make_shared(4, 0.3, 0.6, 1000, material); guide->SetPos(mpos); guide->SetFixed(true); sys->Add(guide); slider = chrono_types::make_shared(0.4, 0.2, 0.5, 1000, material); slider->SetPos(mpos + ChVector3d(0, 0.3, 0)); slider->GetVisualShape(0)->SetColor(ChColor(0.6f, 0.6f, 0.0f)); sys->Add(slider); auto obstacle = chrono_types::make_shared(0.4, 0.4, 0.4, 8000, material); obstacle->SetPos(mpos + ChVector3d(1.5, 0.4, 0)); obstacle->GetVisualShape(0)->SetColor(ChColor(0.2f, 0.2f, 0.2f)); sys->Add(obstacle); } ``` -------------------------------- ### Setup() Source: https://api.chrono.projectchrono.org/classchrono_1_1_ch_solver_complex_pardiso_m_k_l-members.html Sets up the solver for a given system. ```APIDOC ## Setup() ### Description Sets up the solver. This method is virtual and should be implemented by derived classes. ### Method virtual ``` -------------------------------- ### Get Start Position Source: https://api.chrono.projectchrono.org/classchrono_1_1vehicle_1_1_c_r_g_terrain.html Retrieves the starting position and orientation of the road. ```APIDOC ## GetStartPosition ### Description Get the start position (location and orientation). ### Signature ```cpp ChCoordsys GetStartPosition() ``` ### Returns * (*ChCoordsys*): The starting coordinate system (location and orientation) of the road. ``` -------------------------------- ### SetupInitial Source: https://api.chrono.projectchrono.org/classchrono_1_1peridynamics_1_1_ch_matter_peri_b_b-members.html Performs initial setup for the ChMatterPeriBB object. ```APIDOC ## SetupInitial() ### Description Performs the initial setup for the ChMatterPeriBB object. ### Method virtual override ### Parameters None ``` -------------------------------- ### Setup Source: https://api.chrono.projectchrono.org/classchrono_1_1_ch_body_easy_convex_hull_aux_ref.html Performs setup operations for the rigid body. ```APIDOC ## Setup ### Description Performs setup operations. ### Signature `virtual void Setup()` ``` -------------------------------- ### Setup Source: https://api.chrono.projectchrono.org/classchrono_1_1fea_1_1_ch_f_e_model_impl-members.html Performs setup operations for the FE model. ```APIDOC ## Setup ### Description Performs necessary setup operations for the finite element model before simulation begins. ### Method `virtual void Setup()` ``` -------------------------------- ### Setup() Source: https://api.chrono.projectchrono.org/classchrono_1_1peridynamics_1_1_ch_matter_peri_b_bimplicit-members.html Sets up the material properties for the implicit BB peridynamics model. ```APIDOC ## Setup() ### Description Sets up the material properties for the implicit BB peridynamics model. ### Method virtual void Setup() ### Parameters None ``` -------------------------------- ### SetupInitial Source: https://api.chrono.projectchrono.org/classchrono_1_1fea_1_1_ch_node_f_e_axyz_p-members.html Performs initial setup for the node within the system. ```APIDOC ## SetupInitial ### Description Performs initial setup for the node within the system. This is typically called by the simulation manager. ### Method SetupInitial ### Parameters - **system** (ChSystem *) - Pointer to the simulation system. ``` -------------------------------- ### Get Timer Setup Source: https://api.chrono.projectchrono.org/classchrono_1_1_ch_system-members.html Retrieves the total time spent in the system setup phase. ```APIDOC ## GetTimerSetup() const ### Description Returns the total time spent in the system setup phase of the simulation. ### Method `const` ### Endpoint N/A (SDK method) ### Parameters None ### Response - **double**: The time in seconds for the setup phase. ``` -------------------------------- ### Setup Source: https://api.chrono.projectchrono.org/classchrono_1_1_ch_system-members.html Performs the setup phase of the simulation, preparing the system for integration. ```APIDOC ## Setup ### Description Performs the setup phase of the simulation, preparing the system for integration. ### Method `Setup()` ``` -------------------------------- ### Get Solver Setup Count Source: https://api.chrono.projectchrono.org/classchrono_1_1_ch_system-members.html Retrieves the number of times the solver setup has been performed. ```APIDOC ## GetSolverSetupCount() ### Description Returns the number of times the solver setup has been performed. ### Method `const` ### Endpoint N/A (SDK method) ### Parameters None ### Response - **int**: The solver setup count. ``` -------------------------------- ### SetupInitial Source: https://api.chrono.projectchrono.org/classchrono_1_1fea_1_1_ch_f_e_model_integrating.html Performs initial setup operations. ```APIDOC ## SetupInitial ### Description Performs initial setup operations. ### Method `virtual void override` ``` -------------------------------- ### Initial Setup Source: https://api.chrono.projectchrono.org/classchrono_1_1fea_1_1_ch_node_f_e_axyzrot.html Function for the initial setup of the node within a system. ```APIDOC ## SetupInitial ### Description Initial setup. ### Method `void SetupInitial (ChSystem *system)` ``` -------------------------------- ### Setup() Source: https://api.chrono.projectchrono.org/classchrono_1_1_ch_direct_solver_l_scomplex.html Perform the solver setup operations (factorization). Returns true if successful and false otherwise. ```APIDOC ## Setup() ### Description Perform the solver setup operations (factorization). Returns true if successful and false otherwise. ### Method virtual bool ### Endpoint N/A (Method within a class) ### Parameters None ### Request Example N/A ### Response #### Success Response - **bool**: True if setup was successful, false otherwise. ### Response Example N/A ``` -------------------------------- ### Get Number of Setup Calls Source: https://api.chrono.projectchrono.org/classchrono_1_1_ch_solver_m_k_l.html Returns the total number of times the solver's Setup function has been called. ```C++ int GetNumSetupCalls() const ``` -------------------------------- ### SetupInitial Source: https://api.chrono.projectchrono.org/classchrono_1_1fea_1_1_ch_f_e_model_generic.html Performs initial setup operations for the physics item. ```APIDOC ## SetupInitial ### Description Performs initial setup operations for the physics item. ### Signature `virtual void SetupInitial() override` ``` -------------------------------- ### Get Cumulative Setup Time (Assembly) Source: https://api.chrono.projectchrono.org/classchrono_1_1_ch_solver_m_k_l.html Retrieves the cumulative time spent on assembly operations during the Setup phase. ```C++ double GetTimeSetup_Assembly() const ``` -------------------------------- ### Object Properties and Setup Source: https://api.chrono.projectchrono.org/classchrono_1_1_ch_link_lock_spherical.html Functions to get the object's center, perform setup, and force the object to rest. ```APIDOC ## Public Member Functions virtual ChVector3d | GetCenter () const | Get a symbolic 'center' of the object. virtual void | Setup () | Perform setup operations. virtual void | ForceToRest () | Set zero speed (and zero accelerations) in state, without changing the position. ``` -------------------------------- ### Setup Source: https://api.chrono.projectchrono.org/classchrono_1_1_ch_system_s_m_c.html Performs the initial setup of the system, typically by counting bodies and links, preparing internal structures for simulation. ```APIDOC ## Setup ### Description Count the number of bodies and links. ### Method virtual void Setup() ``` -------------------------------- ### GetTimerSetup Source: https://api.chrono.projectchrono.org/classchrono_1_1_ch_system_multicore_n_s_c-members.html Gets the timer for the setup phase. ```APIDOC ## GetTimerSetup() const override ### Description Returns the time spent in the setup phase of the simulation step. ``` -------------------------------- ### ChNodeFEAxyz::SetupInitial Source: https://api.chrono.projectchrono.org/classchrono_1_1fea_1_1_ch_node_f_e_axyz.html Performs initial setup for the node within a given system. ```APIDOC ## SetupInitial ### Description Performs initial setup operations for the node within the context of a Chrono system. ### Method virtual void **SetupInitial** (ChSystem *system) ### Parameters - **system** (ChSystem *) - Pointer to the Chrono system. ``` -------------------------------- ### Get Cumulative Setup Time (Solver Call) Source: https://api.chrono.projectchrono.org/classchrono_1_1_ch_solver_m_k_l.html Retrieves the cumulative time spent on Pardiso calls during the Setup phase. ```C++ double GetTimeSetup_SolverCall() const ``` -------------------------------- ### SetupInitial Source: https://api.chrono.projectchrono.org/classchrono_1_1fea_1_1_ch_f_e_model_impl.html Performs initial setup operations for the model. ```APIDOC ## SetupInitial() ### Description Performs initial setup operations for the model. ### Returns void ``` -------------------------------- ### Setup Source: https://api.chrono.projectchrono.org/classchrono_1_1peridynamics_1_1_ch_matter_peri_springs-members.html Sets up the matter. This is an inline virtual method. ```APIDOC ## Setup ### Description Sets up the matter. ### Signature ```cpp void Setup() ``` ### Class chrono::peridynamics::ChMatterPeriBase ### Inline virtual ``` -------------------------------- ### GetTimeEigenSetup Source: https://api.chrono.projectchrono.org/classchrono_1_1modal_1_1_ch_generalized_eigenvalue_solver-members.html Gets the time taken for eigenvalue setup. ```APIDOC ## GetTimeEigenSetup() ### Description Gets the time taken for eigenvalue setup. ### Method inline const ### Returns Time in seconds. ``` -------------------------------- ### Setup Source: https://api.chrono.projectchrono.org/classchrono_1_1peridynamics_1_1_ch_matter_peri.html Optional method called at each time step. ```APIDOC ## virtual void Setup () ### Description CONSTITUTIVE MODEL - INTERFACE TO IMPLEMENT: (optionally) This function is called at each time step. ### Method POST ``` -------------------------------- ### GetSliceStart Source: https://api.chrono.projectchrono.org/classchrono_1_1_ch_function_repeat.html Gets the starting point of the slice that is being repeated. ```APIDOC ## GetSliceStart ### Description Get the starting point of the slice that should be repeated. ### Returns - double - The starting point of the slice. ``` -------------------------------- ### Perform Setup Operations Source: https://api.chrono.projectchrono.org/classchrono_1_1_ch_hydraulic_actuator2.html Executes setup operations for the physics item. This function is called once before the simulation starts to prepare the item for dynamics. ```c++ virtual void Setup() ``` -------------------------------- ### Example CMAKE_PREFIX_PATH on Windows Source: https://api.chrono.projectchrono.org/tutorial_install_chrono.html An example of how to set the CMAKE_PREFIX_PATH environment variable on Windows to include directories for various installed Chrono dependencies. ```text E:\Packages\eigen\share\eigen3\cmake; E:\Packages\vsg\lib\cmake; E:\Packages\urdf\lib\urdfdom\cmake; E:\Packages\urdf\CMake; E:\Packages\spectra\share\spectra\cmake; E:\Packages\gl\lib\cmake; E:\Packages\mumps\cmake; C:\occt-7.9.2\occt-vc14-64\cmake; C:\Program Files (x86)\Intel\oneAPI\mkl\latest\lib\cmake\mkl; ``` -------------------------------- ### Initialize Source: https://api.chrono.projectchrono.org/classchrono_1_1_ch_system_n_s_c.html Performs initial system setup before analysis. ```APIDOC ## Initialize ### Description Initial system setup before analysis. ### Method void ### Endpoint N/A (Method within a class) ``` -------------------------------- ### GetTimeEigenSetup Source: https://api.chrono.projectchrono.org/classchrono_1_1modal_1_1_ch_sym_gen_eigenvalue_solver_lanczos.html Gets the cumulative time spent on the eigensolver setup. ```APIDOC ## GetTimeEigenSetup ### Description Get cumulative time for the eigensolver setup. ### Method Signature double GetTimeEigenSetup() const ``` -------------------------------- ### Setup() Source: https://api.chrono.projectchrono.org/classchrono_1_1_ch_direct_solver_l_s.html Performs the solver setup operations, analyzing the system matrix if necessary. This method is called when structural changes to the system are detected. ```APIDOC ## Setup() ### Description Perform the solver setup operations. The system descriptor contains the constraints and variables. The argument `analyze` indicates if a full analysis of the system matrix is required. This is true when a structural change in the system was detected (e.g., when a physical component was added to or removed from the Chrono system). Reimplemented from chrono::ChSolver. ### Method bool chrono::ChDirectSolverLS::Setup(ChSystemDescriptor & _sysd, bool _analyze) ### Parameters #### Path Parameters - **_sysd** (ChSystemDescriptor &) - Description: The system descriptor containing constraints and variables. - **_analyze** (bool) - Description: Indicates if a full analysis of the system matrix is required. ``` -------------------------------- ### GetTimeEigenSetup Source: https://api.chrono.projectchrono.org/classchrono_1_1modal_1_1_ch_sym_gen_eigenvalue_solver.html Gets the cumulative time spent on the eigensolver setup. ```APIDOC double GetTimeEigenSetup () const ``` -------------------------------- ### SetupInitial Source: https://api.chrono.projectchrono.org/classchrono_1_1fea_1_1_ch_element_beam_tapered_timoshenko.html Performs the initial setup for the element, precomputing matrices like the local tangent stiffness that do not change during the simulation. ```APIDOC ## SetupInitial() ### Description Initial setup. Precompute mass and matrices that do not change during the simulation, such as the local tangent stiffness Kl of each element, if needed, etc. ### Method Signature `void chrono::fea::ChElementBeamTaperedTimoshenko::SetupInitial(ChSystem * _system_)` ### Overrides Reimplemented from `chrono::fea::ChElementBase`. ``` -------------------------------- ### Get State Block (Velocity Level) Source: https://api.chrono.projectchrono.org/classchrono_1_1_ch_shaft.html Gets all the DOFs packed in a single vector for the speed part, starting at a given block offset. ```APIDOC ## LoadableGetStateBlockVelLevel ### Description Gets all the DOFs packed in a single vector (speed part). ### Method `virtual void LoadableGetStateBlockVelLevel(int block_offset, ChStateDelta &mD) override` ``` -------------------------------- ### Setup() Source: https://api.chrono.projectchrono.org/classchrono_1_1_ch_solver.html Performs setup operations for the solver, preparing it for subsequent solve calls. It takes a ChSystemDescriptor and a boolean indicating if a full matrix analysis is required. Returns true if successful, false otherwise. ```APIDOC ## Setup() ### Description Performs setup operations for the solver. This function prepares the solver for subsequent calls to the solve function. The system descriptor contains the constraints and variables. This function is called only as frequently it is determined that it is appropriate to perform the setup phase. The argument `analyze` indicates if a full analysis of the system matrix is required. This is true when a structural change in the system was detected (e.g., when a physical component was added to or removed from the Chrono system). ### Method `virtual bool chrono::ChSolver::Setup(ChSystemDescriptor & _sysd_, bool _analyze_) ### Parameters #### Path Parameters - **_sysd_** (ChSystemDescriptor &) - The system descriptor containing constraints and variables. - **_analyze_** (bool) - Indicates if a full analysis of the system matrix is required. ### Return Value - bool - True if successful, false otherwise. ``` -------------------------------- ### Get State Block (Position Level) Source: https://api.chrono.projectchrono.org/classchrono_1_1_ch_shaft.html Gets all the DOFs packed in a single vector for the position part, starting at a given block offset. ```APIDOC ## LoadableGetStateBlockPosLevel ### Description Gets all the DOFs packed in a single vector (position part). ### Method `virtual void LoadableGetStateBlockPosLevel(int block_offset, ChState &mD) override` ``` -------------------------------- ### Setup Method Source: https://api.chrono.projectchrono.org/classchrono_1_1_ch_schur_product.html Initializes the ChSchurProduct functor with the necessary data manager. ```APIDOC ## void Setup(ChMulticoreDataManager *data_container_) ### Description Sets up the Schur product calculation by providing the data manager. ### Method void ### Parameters #### Path Parameters - **data_container_** (ChMulticoreDataManager *) - Required - Pointer to the system's data manager. ``` -------------------------------- ### ChSystem::Initialize Source: https://api.chrono.projectchrono.org/classchrono_1_1_ch_system.html Performs the initial system setup before starting the analysis or simulation. ```APIDOC ## ChSystem::Initialize ### Description Initial system setup before analysis. ### Method void ### Usage Call this method after adding all bodies, constraints, and other components to the system, but before starting the simulation. ``` -------------------------------- ### SetupInitial Source: https://api.chrono.projectchrono.org/classchrono_1_1peridynamics_1_1_ch_matter_peri_springs-members.html Sets up the initial state of the matter. This is an inline virtual method. ```APIDOC ## SetupInitial ### Description Sets up the initial state of the matter. ### Signature ```cpp void SetupInitial() ``` ### Class chrono::peridynamics::ChMatterPeriBase ### Inline virtual ``` -------------------------------- ### Node Access Source: https://api.chrono.projectchrono.org/classchrono_1_1fea_1_1_ch_element_beam_tapered_timoshenko_f_p_m.html Methods to get the start and end nodes of the beam element. ```APIDOC ## GetNodeA ### Description Retrieves the first node (beginning) of the beam element. ### Method `std::shared_ptr GetNodeA ()` ### Return Value A shared pointer to the starting `ChNodeFEAxyzrot`. ``` ```APIDOC ## GetNodeB ### Description Retrieves the second node (ending) of the beam element. ### Method `std::shared_ptr GetNodeB ()` ### Return Value A shared pointer to the ending `ChNodeFEAxyzrot`. ``` -------------------------------- ### GetNumSetupCalls Source: https://api.chrono.projectchrono.org/classchrono_1_1_ch_timestepper_implicit-members.html Gets the total number of times the setup phase of the timestepper has been called. ```APIDOC ## GetNumSetupCalls ### Description Gets the total number of times the setup phase of the timestepper has been called. ### Method `GetNumSetupCalls() const` ### Returns (int) The total number of setup calls. ``` -------------------------------- ### SetupInitial Source: https://api.chrono.projectchrono.org/classchrono_1_1peridynamics_1_1_ch_matter_peri_linear_elastic-members.html Performs initial setup for the linear elastic peridynamics matter. This is a virtual override method. ```APIDOC ## SetupInitial ### Description Performs the initial setup specific to the linear elastic peridynamics matter. This is an override of a virtual method. ### Method (Not specified, likely internal or part of a larger system) ### Endpoint (Not applicable) ### Parameters (None) ### Request Example (Not applicable) ### Response (Not applicable) ``` -------------------------------- ### Get Timer LS Setup Source: https://api.chrono.projectchrono.org/classchrono_1_1_ch_system-members.html Retrieves the time spent in setting up the linear solver. ```APIDOC ## GetTimerLSsetup() const ### Description Returns the total time spent in setting up the linear solver. ### Method `const` ### Endpoint N/A (SDK method) ### Parameters None ### Response - **double**: The time in seconds for linear solver setup. ``` -------------------------------- ### Setup Method Source: https://api.chrono.projectchrono.org/classchrono_1_1_ch_schur_product_bilateral-members.html Sets up the ChSchurProductBilateral object with a data manager. ```APIDOC ## Setup(ChMulticoreDataManager *data_container_) ### Description Sets up the ChSchurProductBilateral object by providing a data manager. ### Method Setup ### Endpoint N/A ### Parameters - **data_container_** (ChMulticoreDataManager *) - Pointer to the data manager. ### Request Example None ### Response None ``` -------------------------------- ### GetMassPerUnitLength Source: https://api.chrono.projectchrono.org/classchrono_1_1fea_1_1_ch_beam_section_timoshenko_advanced_generic.html Gets the mass per unit length. For example, in SI units, this would be [kg/m]. ```APIDOC ## GetMassPerUnitLength ### Description Gets the mass per unit length. For example, in SI units, this would be [kg/m]. ### Method `virtual double GetMassPerUnitLength() const override` ``` -------------------------------- ### GetNumSubBlocks Source: https://api.chrono.projectchrono.org/classchrono_1_1_ch_loadable_u_v.html Get the number of DOFs sub-blocks. For example, 1 for a body, 4 for a tetrahedron, etc. ```APIDOC ## GetNumSubBlocks ### Description Get the number of DOFs sub-blocks (e.g., 1 for a body, 4 for a tetrahedron, etc.). ### Method virtual unsigned int GetNumSubBlocks ()=0 ``` -------------------------------- ### ChFieldElementVolume::SetupInitial Source: https://api.chrono.projectchrono.org/classchrono_1_1fea_1_1_ch_field_element_volume.html Performs initial setup for the element, called once before the simulation starts. This function has a default implementation but can be overridden. ```APIDOC ## SetupInitial() ### Description Initial setup (called once before start of simulation). More... ### Method virtual void SetupInitial(ChSystem *system) ``` -------------------------------- ### Get Start Heading Source: https://api.chrono.projectchrono.org/classchrono_1_1vehicle_1_1_c_r_g_terrain.html Retrieves the initial heading (orientation) of the road in radians. This can differ from zero for georeferenced roads. ```APIDOC ## GetStartHeading ### Description Get start heading (in radians), can be different from zero for georeferenced roads. ### Signature ```cpp double GetStartHeading() ``` ### Returns * (*double*): The start heading in radians. ``` -------------------------------- ### SetupInitial Source: https://api.chrono.projectchrono.org/classchrono_1_1fea_1_1_ch_f_e_model_deformation.html Performs initial setup operations for the finite element model. ```APIDOC ## SetupInitial ### Description Performs initial setup operations. ### Method virtual void SetupInitial() override ``` -------------------------------- ### GetPos1 Source: https://api.chrono.projectchrono.org/classchrono_1_1fea_1_1_ch_contact_segment_x_y_z_rot.html Gets the current position of the first node in world coordinates. This provides the spatial location of the segment's starting point. ```APIDOC ## GetPos1 ### Description Get the current position of the first node. ### Method Signature `const ChVector3d& GetPos1() const` ``` -------------------------------- ### GetOffset_L Source: https://api.chrono.projectchrono.org/classchrono_1_1_ch_body_aux_ref.html Gets the offset in the Lagrange multipliers vector. This indicates where the body's constraint forces start in the global Lagrange multipliers vector. ```APIDOC ## GetOffset_L ### Description Get offset in the Lagrange multipliers. ### Method GET ### Endpoint `/bodies/{id}/offset/L` ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the rigid body. ### Response #### Success Response (200) - **offset_L** (unsigned int) - The offset for the Lagrange multipliers. ``` -------------------------------- ### Setup Source: https://api.chrono.projectchrono.org/classchrono_1_1modal_1_1_ch_modal_assembly-members.html Sets up the modal assembly. ```APIDOC ## Setup ### Description Sets up the modal assembly. ### Method `Setup() override` ``` -------------------------------- ### GetOffset_w Source: https://api.chrono.projectchrono.org/classchrono_1_1_ch_body_aux_ref.html Gets the offset in the state vector for the speed part. This indicates where the body's velocity variables start in the global state vector. ```APIDOC ## GetOffset_w ### Description Get offset in the state vector (speed part). ### Method GET ### Endpoint `/bodies/{id}/offset/w` ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the rigid body. ### Response #### Success Response (200) - **offset_w** (unsigned int) - The offset for the speed part of the state vector. ``` -------------------------------- ### SetupProblem Source: https://api.chrono.projectchrono.org/classchrono_1_1_ch_iterative_solver_l_s.html Initializes the solver with the current sparse matrix. ```APIDOC ## SetupProblem()=0 ### Description Initializes the solver with the current sparse matrix and returns true if successful. ### Returns - **bool** - True if the setup was successful, false otherwise. ``` -------------------------------- ### GetOffset_x Source: https://api.chrono.projectchrono.org/classchrono_1_1_ch_body_aux_ref.html Gets the offset in the state vector for the position part. This indicates where the body's position variables start in the global state vector. ```APIDOC ## GetOffset_x ### Description Get offset in the state vector (position part). ### Method GET ### Endpoint `/bodies/{id}/offset/x` ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the rigid body. ### Response #### Success Response (200) - **offset_x** (unsigned int) - The offset for the position part of the state vector. ``` -------------------------------- ### Setup Source: https://api.chrono.projectchrono.org/classchrono_1_1_ch_link_mate_cylindrical.html Performs necessary setup operations for the physics item before simulation begins. ```APIDOC ## Setup ### Description Performs essential setup operations for the physics item. This function is typically called once before the simulation starts to initialize internal states and structures. ### Method `virtual void Setup ()` ``` -------------------------------- ### Repeat Parameter Example Source: https://api.chrono.projectchrono.org/_y_a_m_l_schema_mbs_model.html Specifies how a function should be periodically replicated. The 'start' defines the initial point, 'width' the period, and 'shift' the value offset for replication. ```yaml repeat: start: 1.0 width: 2.0 shift: 3.0 ``` -------------------------------- ### Setup Source: https://api.chrono.projectchrono.org/classchrono_1_1_ch_assembly.html Counts the number of bodies, links, and meshes, and computes the offsets of object states in the global state. This method assumes that the starting offsets are already set. ```APIDOC ## Setup() ### Description Counts the number of bodies, links, and meshes. Computes the offsets of object states in the global state. Assumes that this->offset_x this->offset_w this->offset_L are already set as starting point for offsetting all the contained sub objects. ### Method Signature `void chrono::ChAssembly::Setup()` ``` -------------------------------- ### StateSetup (general) Source: https://api.chrono.projectchrono.org/classchrono_1_1_ch_system_multicore_s_m_c.html Sets up the system state. ```APIDOC ## virtual void StateSetup (ChState &y, ChStateDelta &dy) ### Description Set up the system state. ### Method virtual void ``` -------------------------------- ### StateSetup (Integrable) Source: https://api.chrono.projectchrono.org/classchrono_1_1_ch_system_s_m_c.html Sets up the system state. ```APIDOC ## chrono::ChIntegrable virtual void StateSetup (ChState &y, ChStateDelta &dy) ### Description Set up the system state. ### Method virtual void ``` -------------------------------- ### chrono::ChTimerMulticore Source: https://api.chrono.projectchrono.org/classchrono_1_1_ch_timer_multicore.html Provides methods to add, start, stop, retrieve time, and get run counts for named timers. It also allows for printing a report of all timers. ```APIDOC ## Class chrono::ChTimerMulticore ### Description Utility class for managing a collection of timer objects. ### Methods * **AddTimer** (`const std::string &name`) Adds a new timer with the specified name. * **Reset** () Resets all timers managed by this object. * **start** (`const std::string &name`) Starts the timer with the specified name. * **stop** (`const std::string &name`) Stops the timer with the specified name. * **GetTime** (`const std::string &name`) const Returns the elapsed time for the timer with the specified name. * **GetRuns** (`const std::string &name`) const Returns the number of times the timer with the specified name has been run. * **PrintReport** () const Prints a report of all managed timers. ### Attributes * **total_timers** (int) The total number of timers managed. * **timer_list** (std::map< std::string, TimerData >) A map storing timer data, keyed by timer name. * **it** (std::map< std::string, TimerData >::iterator) An iterator for the timer list. ```