cmparams module¶
Interface for contMech Parameters¶
This module mimicks the objects defined in a contMech simulation and their attributes, which can be derived from the corresponding params file.
API documentation¶
- class cmparams.gfmdSheet(newID)[source]¶
Bases:
object- ID = 0¶
- contactMod = 1¶
- dpRamp = 0¶
- dzRamp = 0¶
- dzStep = 0¶
- elastExpnt0 = 1¶
- f3dMovie = 0¶
- fAddSWR = 0¶
- fBoxMuller = 0¶
- fConstCOM = 0¶
- fDispX = 0¶
- fDispY = 0¶
- fDumpMaxwell = 0¶
- fExtrapolateInf = 0¶
- fKelvinVoigt = 0¶
- fLateral = 0¶
- fMassWeightg = 1¶
- fMaxwell = 0¶
- fOnSitePeriod = 0¶
- fOnSitePotential = 0¶
- fRollOff = 1¶
- fRoughAdd = 0¶
- fRoughNorm = 1¶
- fRoughRead = 0¶
- fSteppedRamp = 0¶
- fThickness0 = 0¶
- fTopoAdd = 0¶
- fTopoRead = 0¶
- frictRelax = 500¶
- frictionCoeffOS = 0¶
- fzOpposite = 0¶
- gammaOnSite = 0¶
- heightFlatPunch = 1¶
- heightSWR = 0.1¶
- hertzExpnt = 2¶
- hurst = 0.8¶
- konfigName = 'konfig'¶
- lambdaR = 0.5¶
- lambdaS = 0.05¶
- massGFMD = 1.0¶
- nElast = 0¶
- nMaxwell = 1¶
- nVeloTurnStep = 0¶
- nqxAddSWR = 2¶
- nqyAddSWR = 2¶
- peklenik = 1¶
- poisson0 = 0.25¶
- pressFinal = 0¶
- pressInit = 0¶
- rKV_LPF = 4¶
- rRoughNorm = 1¶
- rSphere = 0.1¶
- rVeloTurnStep = 0¶
- rXhertz = 0¶
- rYhertz = -1¶
- radiusFlatPunch = 0.25¶
- rampRelax = 350¶
- rampSteps = 150¶
- resolMovie = 512¶
- scalKV = 1000¶
- stiffness0 = 0.5¶
- tauKV = 1¶
- thickness0 = 1¶
- vX = 0¶
- vXOnSite = 0¶
- vY = 0¶
- vYOnSite = 0¶
- veloTurnPress = 0¶
- vzConstCOM = 0¶
- zConstCOM = 0¶
- zOpposite = 0¶
- zeroModeMass = 1¶
- class cmparams.interSheet(newID)[source]¶
Bases:
object- ID = 0¶
- fConstraint = 0¶
- fDumpFrame = 0¶
- fDumpGap = 0¶
- fDumpLateral = 0¶
- fPotential = 0¶
- fPotentialTest = 0¶
- frictRelax = 1¶
- frictionCoeff = 0¶
- nTimeOff = 0¶
- nTimeOn = 0¶
- potCurve = 0¶
- potCurveRel = 0¶
- potRange = 0¶
- resolMovie = 512¶
- sheetID0 = 0¶
- sheetID1 = 1¶
- surfEnerg = 0¶
- cmparams.read(file)[source]¶
Read parameters from a params.in or params.out file of a contMech simulation.
- Parameters:
file (str) – Filepath to a contMech params file.
- Returns:
sim (simulation) – object containing the same objects and attributes as a contMech simulation using the same params file.
- class cmparams.simulation(path)[source]¶
Bases:
object- INTER = []¶
- SHEET = []¶
- dTime = 0¶
- dampGlobal = 1.5¶
- fFire = 0¶
- fLangevin = 0¶
- fLogMeasure = 0¶
- fireDecrmt = 1¶
- fireIncrmt = 1¶
- fireRedrct = 0¶
- frameInterval = 0¶
- freqFrame = 0¶
- inter = []¶
- lengthX = 0¶
- lengthY = 0¶
- nInter = 0¶
- nRelax = 0¶
- nSheet = 0¶
- nTime = 0¶
- nxGlobal = 0¶
- nyGlobal = 0¶
- path = ''¶
- randSeed = 4712¶
- sheet = []¶
- tempFinal = 0¶
- tempInit = 0¶