Model.h

Go to the documentation of this file.

// SPDX-License-Identifier: MIT
// Copyright (c) 2021-2025 MPM-Geomechanics Development Team
 
#ifndef MODEL_H_
#define MODEL_H_
 
#include "Eigen/Core"
using Eigen::Vector3d;
 
#include<string>
using std::string;
 
#include <chrono>
 
namespace ModelSetup {
 
    enum StressUpdateScheme{ USF, USL, MUSL };
 
    enum DampingType { 
        UNDAMPED,                  
        LOCAL,                     
        KINETIC_DYNAMIC_RELAXATION 
    };
 
    enum OperationalSystem{ WINDOWS, LINUX };
 
    enum InterpolationFunctionType{ LINEAR, GIMP };
 
    enum class HydroMechanicalCouplingType { NONE, ONE_WAY };
 
    bool getWindowsSystem();
 
    bool getLinuxSystem();
    
    bool getLoadState();
 
    void setLoadState(bool load_state_activated);
 
    bool getSaveState();
 
    void setSaveState(bool save_state_activated);
 
    unsigned getContributionNodesNum();
    
    double getTimeStep();
    
    void setTimeStep(double time_step);
 
    double getTime();
    
    void setTime(double simulation_time);
 
    unsigned getResultNum();
    
    void setResultNum(unsigned total_results);
    
    unsigned getResultSteps();
 
    double getCriticalTimeStepMultiplier();
    
    void setCriticalTimeStepMultiplier(double critical_time_step_multiplier);
 
    unsigned getThreads();
    
    void setThreads(unsigned n_threads);
 
    bool getContactActive();
    
    void setContactActive(bool is_contact_activated);
 
    bool getSecondContactActive();
 
    void setSecondContactActive(bool is_contact_activated);
 
    bool getContactNormal();
 
    void setContactNormal(int normal_type);
 
    bool getGravityActive();
    
    void setGravityActive(bool is_gravity_activated);
 
    const Vector3d& getGravity();
    
    void setGravity(const Vector3d& gravity);
 
    bool getAxisymetricActive();
    
    void setAxisymetricActive(bool if_axysimentric_active);
 
    bool getJanumannActive();
    
    void setJanumannActive(bool if_jaumann_active);
 
    string getInputFile();
    
    void setInputFile(string file_name);
 
    ModelSetup::StressUpdateScheme getUpdateStressScheme();
    
    void setUpdateStressScheme(ModelSetup::StressUpdateScheme stress_sheme_update);
 
    ModelSetup::DampingType getDamping();
    
    double getDampingLocal();
 
    void setDampingLocalValue(double alpha);
 
    void setDampingType(ModelSetup::DampingType dampingType);
    
    ModelSetup::DampingType getDampingType();
 
    ModelSetup::InterpolationFunctionType getInterpolationFunction();
    
    void setInterpolationFunction(ModelSetup::InterpolationFunctionType interpolation_functions_type);
    
    void setNumThreads(unsigned nThreads);
    
    bool getSeismicAnalysisActive();
 
    void setSeismicAnalysisActive(bool seismic_analysis_active);
 
    bool getTwoPhaseActive();
 
    void setTwoPhaseActive(bool two_phase_calculation_active);
    
    void setInitialSimulationTime( std::chrono::system_clock::time_point initialTime);
 
    std::chrono::system_clock::time_point getInitialSimulationTime( );
 
    std::string getSeismicFileName();
 
    double getCurrentTime();
 
    void setCurrentTime(double currentTime);
 
    bool getTerrainContactActive();
    
    void setTerrainContactActive(bool);
 
    HydroMechanicalCouplingType getHydroMechanicalCouplingType();
    
    void setHydroMechanicalCouplingType(HydroMechanicalCouplingType type);
 
    bool getHydroMechOneWayEnabled();
 
    int getLoopCounter();
 
    void setLoopCounter(int a);
 
    int incrementLoopCounter();
};
 
#endif /* MODEL_H_ */