[cig-commits] r3822 -
short/3D/PyLith/branches/pylith-0.8/pylith3d/pylith3d
willic3 at geodynamics.org
willic3 at geodynamics.org
Tue Jun 20 08:44:05 PDT 2006
Author: willic3
Date: 2006-06-20 08:44:05 -0700 (Tue, 20 Jun 2006)
New Revision: 3822
Modified:
short/3D/PyLith/branches/pylith-0.8/pylith3d/pylith3d/Pylith3d_scan.py
Log:
Added documentation to inventory, and altered the status of some files.
Modified: short/3D/PyLith/branches/pylith-0.8/pylith3d/pylith3d/Pylith3d_scan.py
===================================================================
--- short/3D/PyLith/branches/pylith-0.8/pylith3d/pylith3d/Pylith3d_scan.py 2006-06-20 00:07:17 UTC (rev 3821)
+++ short/3D/PyLith/branches/pylith-0.8/pylith3d/pylith3d/Pylith3d_scan.py 2006-06-20 15:44:05 UTC (rev 3822)
@@ -266,8 +266,8 @@
analysisType = self.inventory.analysisType
pythonTimestep = self.inventory.pythonTimestep
- self._asciiOutputFile = outputFile(Inventory.asciiOutputFile, required)
- self._plotOutputFile = outputFile(Inventory.plotOutputFile, required)
+ self._asciiOutputFile = outputFile(Inventory.asciiOutputFile, optional)
+ self._plotOutputFile = outputFile(Inventory.plotOutputFile, optional)
self._coordinateInputFile = inputFile(Inventory.coordinateInputFile, required)
self._bcInputFile = inputFile(Inventory.bcInputFile, required)
self._winklerInputFile = inputFile(Inventory.winklerInputFile, optional)
@@ -282,9 +282,10 @@
self._prestressInputFile = inputFile(Inventory.prestressInputFile, unused)
self._tractionInputFile = inputFile(Inventory.tractionInputFile, unused)
self._splitNodeInputFile = inputFile(Inventory.splitNodeInputFile, optional)
- self._slipperyNodeInputFile = inputFile(Inventory.slipperyNodeInputFile, optional)
- self._differentialForceInputFile = inputFile(Inventory.differentialForceInputFile, optional)
- self._slipperyWinklerInputFile = inputFile(Inventory.slipperyWinklerInputFile, optional)
+ # Slippery nodes are not yet implemented in PyLith-0.8.
+ self._slipperyNodeInputFile = inputFile(Inventory.slipperyNodeInputFile, unused)
+ self._differentialForceInputFile = inputFile(Inventory.differentialForceInputFile, unused)
+ self._slipperyWinklerInputFile = inputFile(Inventory.slipperyWinklerInputFile, unused)
# The call to glob() is somewhat crude -- basically, determine
# if any files might be in the way.
@@ -653,47 +654,116 @@
OutputFile = pyre.inventory.str
InputFile = pyre.inventory.str
+ # Title
title = pyre.inventory.str("title",
- default="Patchtest 1 for linear hex elements, full quadrature.")
+ default="PyLith-0.8 Simulation")
+ title.meta['tip'] = "Title for this simulation"
+
+ # Basename for all files (may be overridden by specific filename entries).
fileRoot = pyre.inventory.str("fileRoot", default="pt1")
+ fileRoot.meta['tip'] = "Root pathname for simulation (all filenames derive from this)."
- keywordEqualsValueFile = InputFile("keywordEqualsValueFile",default="${fileRoot}.keyval")
+ # Output filenames (all are optional).
asciiOutputFile = OutputFile("asciiOutputFile",default="${fileRoot}.ascii")
+ asciiOutputFile.meta['tip'] = "Pathname for ascii output file (overrides default from fileRoot)."
+
plotOutputFile = OutputFile("plotOutputFile",default="${fileRoot}.plot")
+ plotOutputFile.meta['tip'] = "Pathname for plot output file (overrides default from fileRoot)."
+
ucdOutputRoot = MacroString("ucdOutputRoot",default="${fileRoot}")
+ ucdOutputRoot.meta['tip'] = "Base name for UCD output files (overrides default from fileRoot)."
+
+ # Required input files.
coordinateInputFile = InputFile("coordinateInputFile",default="${fileRoot}.coord")
+ coordinateInputFile.meta['tip'] = "Pathname for coordinate input file (overrides default from fileRoot)."
+
bcInputFile = InputFile("bcInputFile",default="${fileRoot}.bc")
+ bcInputFile.meta['tip'] = "Pathname for boundary condition input file (overrides default from fileRoot)."
+
+ timeStepInputFile = InputFile("timeStepInputFile",default="${fileRoot}.time")
+ timeStepInputFile.meta['tip'] = "Pathname for time step definitions input file (overrides default from fileRoot)."
+
+ stateVariableInputFile = InputFile("stateVariableInputFile",default="${fileRoot}.statevar")
+ stateVariableInputFile.meta['tip'] = "Pathname for file defining which state variables to output (overrides default from fileRoot)."
+
+ materialPropertiesInputFile = InputFile("materialPropertiesInputFile",default="${fileRoot}.prop")
+ materialPropertiesInputFile.meta['tip'] = "Pathname for file defining material properties (overrides default from fileRoot)."
+
+ connectivityInputFile = InputFile("connectivityInputFile",default="${fileRoot}.connect")
+ connectivityInputFile.meta['tip'] = "Pathname for connectivity input file (overrides default from fileRoot)."
+
+ # This file is only required for time-dependent problems.
+ fullOutputInputFile = InputFile("fullOutputInputFile",default="${fileRoot}.fuldat")
+ fullOutputInputFile.meta['tip'] = "Pathname for file defining when to provide output (overrides default from fileRoot)."
+
+ # Optional input files.
+ keywordEqualsValueFile = InputFile("keywordEqualsValueFile",default="${fileRoot}.keyval")
+ keywordEqualsValueFile.meta['tip'] = "Pathname for keyword = value file (overrides default from fileRoot)."
+
winklerInputFile = InputFile("winklerInputFile",default="${fileRoot}.wink")
+ winklerInputFile.meta['tip'] = "Pathname for Winkler force input file (overrides default from fileRoot)."
+
rotationInputFile = InputFile("rotationInputFile",default="${fileRoot}.skew")
- timeStepInputFile = InputFile("timeStepInputFile",default="${fileRoot}.time")
- fullOutputInputFile = InputFile("fullOutputInputFile",default="${fileRoot}.fuldat")
- stateVariableInputFile = InputFile("stateVariableInputFile",default="${fileRoot}.statevar")
+ rotationInputFile.meta['tip'] = "Pathname for skew rotations input file (overrides default from fileRoot)."
+
loadHistoryInputFile = InputFile("loadHistoryInputFile",default="${fileRoot}.hist")
- materialPropertiesInputFile = InputFile("materialPropertiesInputFile",default="${fileRoot}.prop")
+ loadHistoryInputFile.meta['tip'] = "Pathname for file defining load histories (overrides default from fileRoot)."
+
+ splitNodeInputFile = InputFile("splitNodeInputFile",default="${fileRoot}.split")
+ splitNodeInputFile.meta['tip'] = "Pathname for split node input file (overrides default from fileRoot)."
+
+ # Unused input files.
materialHistoryInputFile = InputFile("materialHistoryInputFile",default="${fileRoot}.mhist")
- connectivityInputFile = InputFile("connectivityInputFile",default="${fileRoot}.connect")
+ materialHistoryInputFile.meta['tip'] = "Pathname for file defining material histories (overrides default from fileRoot -- presently unused)."
+
prestressInputFile = InputFile("prestressInputFile",default="${fileRoot}.prestr")
+ prestressInputFile.meta['tip'] = "Pathname for prestress input file (overrides default from fileRoot -- presently unused)."
+
tractionInputFile = InputFile("tractionInputFile",default="${fileRoot}.tract")
- splitNodeInputFile = InputFile("splitNodeInputFile",default="${fileRoot}.split")
+ tractionInputFile.meta['tip'] = "Pathname for traction BC input file (overrides default from fileRoot -- presently unused)."
+
slipperyNodeInputFile = InputFile("slipperyNodeInputFile",default="${fileRoot}.slip")
+ slipperyNodeInputFile.meta['tip'] = "Pathname for slippery node input file (overrides default from fileRoot -- presently unused)."
+
differentialForceInputFile = InputFile("differentialForceInputFile",default="${fileRoot}.diff")
+ differentialForceInputFile.meta['tip'] = "Pathname for file defining slippery node differential forces (overrides default from fileRoot -- presently unused)."
+
slipperyWinklerInputFile = InputFile("slipperyWinklerInputFile",default="${fileRoot}.winkx")
-
+ slipperyWinklerInputFile.meta['tip'] = "Pathname for file defining slippery node Winkler forces (overrides default from fileRoot -- presently unused)."
+
+ # Output option flags.
asciiOutput = pyre.inventory.str("asciiOutput",default="echo")
asciiOutput.validator = pyre.inventory.choice(["none","echo","full"])
+ asciiOutput.meta['tip'] = "Type of ascii output desired (none, echo, full)."
+
plotOutput = pyre.inventory.str("plotOutput",default="none")
plotOutput.validator = pyre.inventory.choice(["none","ascii","binary"])
+ plotOutput.meta['tip'] = "Type of plot output desired (none, ascii, binary)."
+
ucdOutput = pyre.inventory.str("ucdOutput",default=None)
ucdOutput.validator = pyre.inventory.choice(["none","ascii","binary"])
+ ucdOutput.meta['tip'] = "Type of UCD output desired (none, ascii, binary)."
+
+ # Additional option flags.
analysisType = pyre.inventory.str("analysisType",default="fullSolution")
analysisType.validator = pyre.inventory.choice(["dataCheck","stiffnessFactor",
"elasticSolution","fullSolution"])
+ analysisType.meta['tip'] = "Type of analysis (dataCheck, stiffnessFactor, elasticSolution, fullSolution)."
+
pythonTimestep = pyre.inventory.bool("pythonTimestep",default=False)
+ pythonTimestep.meta['tip'] = "Whether to use python timestepping loop (enables VTK output for time-dependent solution)."
+
debuggingOutput = pyre.inventory.bool("debuggingOutput",default=False)
- autoRotateSlipperyNodes = pyre.inventory.bool("autoRotateSlipperyNodes",default=True)
+ debuggingOutput.meta['tip'] = "Whether to produce debugging output."
+
numberCycles = pyre.inventory.int("numberCycles",default=1)
+ numberCycles.meta['tip'] = "Number of cycles of the given timestep definitions to perform (default=1)."
+ # Unused option flags.
+ autoRotateSlipperyNodes = pyre.inventory.bool("autoRotateSlipperyNodes",default=True)
+ autoRotateSlipperyNodes.meta['tip'] = "Whether to performa automatic rotation for slippery nodes (presently unused)."
+
# version
# $Id: Pylith3d_scan.py,v 1.19 2005/06/24 20:22:03 willic3 Exp $
More information about the Cig-commits
mailing list