Data Fields

{
  "name": "StatsSetting",
  "namespace": "sofa::component::setting",
  "module": "Sofa.Component.Setting",
  "include": "sofa/component/setting/StatsSetting.h",
  "doc": "Stats settings.\n\nClass for the configuration of stats settings.",
  "inherits": [
    "ConfigurationSetting"
  ],
  "templates": [],
  "data_fields": [
    {
      "name": "d_dumpState",
      "type": "bool",
      "xmlname": "dumpState",
      "help": "Dump state vectors at each time step of the simulation"
    },
    {
      "name": "d_logTime",
      "type": "bool",
      "xmlname": "logTime",
      "help": "Output in the console an average of the time spent during different stages of the simulation"
    },
    {
      "name": "d_exportState",
      "type": "bool",
      "xmlname": "exportState",
      "help": "Create GNUPLOT files with the positions, velocities and forces of all the simulated objects of the scene"
    }
  ],
  "links": [],
  "methods": [],
  "description": "The `StatsSetting` component in the SOFA framework is used for configuring various statistical settings during simulations. It inherits from `ConfigurationSetting`, indicating that it plays a role in setting up simulation configurations related to statistics and performance monitoring.\n\nThis component provides several boolean fields to control different aspects of data collection and logging:\n- **dumpState**: When enabled, this setting dumps state vectors at each time step of the simulation. This can be useful for detailed analysis but may increase computational overhead and storage requirements.\n- **logTime**: Enables outputting an average of the time spent during different stages of the simulation in the console. This helps in profiling and understanding performance bottlenecks.\n- **exportState**: When enabled, it creates GNUPLOT files with positions, velocities, and forces of all simulated objects in the scene at each time step. These files can be used for post-processing and visualization.\n\nThe `StatsSetting` component does not directly interact with other components through specific methods but provides configuration settings that influence how simulation data is collected and logged. It can be integrated into a SOFA scene to enable detailed performance monitoring and state logging.",
  "maths": "The `StatsSetting` component in the SOFA framework does not directly contribute to the mathematical or physical modeling aspects of Finite Element Method (FEM) simulations. Instead, it serves as a configuration tool for collecting and logging various statistics during the simulation process. Here is a detailed description of its role and behavior:\n\n### Governing Equations and Operators\nThe `StatsSetting` component does not implement any governing equations or operators directly related to FEM such as mass matrix \\(M\\), stiffness matrix \\(K\\), internal force vector \\(f_{int}\\), residual vector \\(R\\), etc. It is purely a setting management tool.\n\n### Constitutive and Kinematic Laws\nThe `StatsSetting` component does not involve any constitutive or kinematic laws such as strain measures, stress tensors, hyperelastic potentials, damping models, constraint Jacobians, etc. Its primary role is to configure the logging of simulation data rather than influencing material behavior or deformation.\n\n### Role in the Global FEM Pipeline\nThe `StatsSetting` component fits into the broader variational / Lagrangian mechanics framework by enabling detailed performance and state monitoring during the simulation process, but it does not directly participate in any of the core numerical steps such as assembly, time integration, nonlinear solve, linear solve, constraint handling, or mapping.\n\n- **Assembly**: No direct role in assembling global matrices and vectors.\n- **Time Integration**: No impact on the time integration schemes (e.g., implicit Euler).\n- **Nonlinear Resolution**: Does not contribute to solving nonlinear systems.\n- **Linear Resolution**: Not involved in iterative solvers or preconditioning techniques.\n- **Update**: Does not affect state updates or velocity reconstructions.\n\n### Numerical Methods and Discretization Choices\nThe `StatsSetting` component does not encode any specific numerical methods or discretization choices. Instead, it provides configuration options for logging data:\n\n- **dumpState**: When enabled (`true`), this setting causes the dumping of state vectors (positions, velocities) at each time step during the simulation.\n- **logTime**: Enables logging average times spent in different stages of the simulation into the console. This is useful for profiling and understanding performance bottlenecks.\n- **exportState**: When enabled (`true`), this setting generates GNUPLOT files containing positions, velocities, and forces of all simulated objects at each time step.\n\n### Integration with Variational / Lagrangian Mechanics Framework\nThe `StatsSetting` component supports the broader variational / Lagrangian mechanics framework by providing tools for detailed performance monitoring and state logging. This can aid in understanding the behavior and efficiency of FEM simulations, but it does not influence the core physical or mathematical models.\n\n### Conclusion\nIn summary, the `StatsSetting` component is a configuration tool that enables detailed logging and profiling during FEM simulations without directly affecting the physical or numerical aspects of the simulation process.",
  "abstract": "`StatsSetting` configures statistical settings for simulations by controlling data collection and logging options such as dumping state vectors, logging time spent in different stages, and exporting GNUPLOT files with positions, velocities, and forces.",
  "sheet": "# StatsSetting\n\n## Overview\nThe `StatsSetting` component is used to configure various statistical settings during SOFA simulations. It inherits from the `ConfigurationSetting` class and provides options for detailed performance monitoring and state logging.\n\n## Parameters and Data\n- **dumpState**: Boolean field (`bool`) that, when enabled (`true`), dumps state vectors at each time step of the simulation. This can be useful for detailed analysis but may increase computational overhead and storage requirements.\n- **logTime**: Boolean field (`bool`) that, when enabled (`true`), outputs an average of the time spent during different stages of the simulation in the console. This helps in profiling and understanding performance bottlenecks.\n- **exportState**: Boolean field (`bool`) that, when enabled (`true`), creates GNUPLOT files with positions, velocities, and forces of all simulated objects at each time step. These files can be used for post-processing and visualization.\n\n## Practical Notes\nEnabling `dumpState`, `logTime`, or `exportState` may increase computational overhead and storage requirements. It is recommended to use these options judiciously based on the specific needs of the simulation."
}