Configuration

Default configuration

class postprocess.config.default_config.EnvConfig(language='english', resultsPath='tmp_results/', intForcPath='internalForces/', verifPath='verifications/', reportPath='annex/', reportResultsPath='annex/', grWidth='\\linewidth', fNameMark='env_config.py')

Bases: postprocess.output_styles.OutputStyle

Generic configuration of XC environment variables.

Variables

grWidth – size of the graphics to be included in the annex

cleandirs()

Clean all the files in the working directory.

compileCode(filename)

Execute the code in the file argument.

Parameters

filename – name of the file to execute.

getWorkingDirectory()

Return the current working directory.

makedirs(pth)

Recursive directory creation function. Like mkdir(), but

makes all intermediate-level directories needed to contain

the leaf directory.

Parameters

path – the path to create.

open(fileName, mode='r', buffering=- 1, encoding=None, errors=None, newline=None, closefd=True, opener=None)

Open file and return a corresponding file object..

Parameters

• fileName – the path and name of the file.

• mode – see Python documentation for open built-in function.

• bufferting – see Python documentation for open built-in function.

• encoding – see Python documentation for open built-in function.

• errors – see Python documentation for open built-in function.

• newline – see Python documentation for open built-in function.

• closefd – see Python documentation for open built-in function.

• opener – see Python documentation for open built-in function.

setWorkingDirectory(pth)

Assign the working directory.

Parameters

pth – path to use as working directory.

class postprocess.config.default_config.ProjectDirTree(resultsPath, intForcPath, verifPath, reportPath, reportResultsPath, fNameMark='env_config.py')

Bases: object

Paths to project directories.

Variables

• intForcPath – relative path from the model path of the directory where results of internal forces are placed.

• verifPath – relative path from the model path of the directory where results of limit state verifications are placed

• reportPath – relative path of the directory where calculation report files are placed

:ivar reportResultsPathrelative path from reportPath of the directory where to place

graphic and text files to be included in the report

cleanWorkingDirectory()

Clean all the files in the working directory.

createTree()

Create the project directory tree.

findResultsFile(fileName: str)

Search for a folder inside the results directory.

Parameters

fileName – name for the folder to find.

findResultsPath(folderName: str)

Search for a folder inside the results directory.

Parameters

folderName – name for the folder to find.

getFullConnectionsResultsPath()

Return the relative path for the fatigue verification graphics files.

getFullGraphicsPath()

Return the full path for the graphic files.

getFullReactionsResultsPath()

Return the relative path for the fatigue verification graphics files.

getFullReportPath()

Return the full path for the report files.

getFullResultsPath()

Return the full path for the files that contains results.

getFullTextReportPath()

Return the full path for the text report files.

getFullVerifPath()

Return the full path for the limit state checking files.

getInternalForcesResultsPath()

Return the path for the files that contains the internal forces.

getMainPaths()

Return the main paths used in the project.

getPathList()

Return the project directory tree.

getReactionsResultsPath()

Return the path for the files that contains the reactions.

getReportBucklingFile()

Return the path of the buckling verification report file.

getReportBucklingGrPath()

Return the path for the buckling verification graphics files.

getReportCrackFreqFile()

Return the path of the crack verification report file (frequent loads).

getReportCrackFreqGrPath()

Return the path for the crack verification graphics files (frequent loads).

getReportCrackQpermFile()

Return the path of the crack verification report file (quasi-permanent loads).

getReportCrackQpermGrPath()

Return the path for the crack verification graphics files (quasi-permanent loads).

getReportCrackRareFile()

Return the path of the crack verification report file (rare loads).

getReportCrackRareGrPath()

Return the path for the crack verification graphics files (rare loads).

getReportFatigueFile()

Return the path of the fatigue verification report file.

getReportFatigueGrPath()

Return the path for the fatigue verification graphics files.

getReportFile(limitStateLabel)

Return the path of the verification report file

for the limit state argument.

Parameters

limitStateLabel – label identifying the limit state.

getReportGrPath(limitStateLabel)

Return the full path for the verification graphics files

for the limit state argument.

Parameters

limitStateLabel – label identifying the limit state.

getReportLoadsFile()

Return the path for the load report file.

getReportLoadsGrPath()

Return the path for the load graphic files.

getReportNormStrFile()

Return the path of the normal stresses verification report file.

getReportNormStrGrPath()

Return the path for the normal stresses verification graphics files.

getReportRltvGrPath(limitStateLabel)

Return the relative path for the verification graphics files

for the limit state argument.

Parameters

limitStateLabel – label identifying the limit state.

getReportSectionsFile()

Return the full path for the sections report file.

getReportSectionsGrPath()

Return the full path for the sections graphic files.

getReportShearFile()

Return the path of the shear verification report file.

getReportShearGrPath()

Return the path for the shear verification graphics files.

getReportSimplLCFile()

getReportSimplLCGrPath()

getReportTorsionFile()

Return the path of the torsion verification report file.

getReportTorsionGrPath()

Return the path for the torsion verification graphics files.

getReportVonMisesStressFile()

Return the path of the VonMisesStress verification report file.

getReportVonMisesStressGrPath()

Return the path for the VonMisesStress verification graphics files.

getRltvConnectionsResultsPath()

Return the relative path for the fatigue verification graphics files.

getRltvGraphicsPath()

Return the relative path for the graphic files.

getRltvReactionsResultsPath()

Return the relative path for the fatigue verification graphics files.

getRltvReportBucklingGrPath()

Return the path for the buckling verification graphics files.

getRltvReportCrackFreqGrPath()

Return the path for the crack verification graphics files (frequent loads).

getRltvReportCrackQpermGrPath()

Return the path for the crack verification graphics files (quasi-permanent loads).

getRltvReportCrackRareGrPath()

Return the path for the crack verification graphics files (rare loads).

getRltvReportFatigueGrPath()

Return the path for the fatigue verification graphics files.

getRltvReportLoadsGrPath()

Return the relative path for the load graphic files.

getRltvReportNormStrGrPath()

Return the path for the normal stresses verification graphics files.

getRltvReportPath()

Return the relative path for the report files.

getRltvReportSectionsGrPath()

Return the relative path for the sections graphic files.

getRltvReportShearGrPath()

Return the path for the shear verification graphics files.

getRltvReportSimplLCGrPath()

getRltvReportTorsionGrPath()

Return the path for the torsion verification graphics files.

getRltvReportVonMisesStressGrPath()

Return the path for the VonMisesStress verification graphics files.

getRltvResultsPath()

Return the relative path for the files that contains results.

getRltvTextReportPath()

Return the relative path for the text report files.

getVerifBucklingFile()

Return the path of the buckling verification results file.

getVerifCrackFreqFile()

Return the path of the crack verification results file (frequent loads).

getVerifCrackQpermFile()

Return the path of the crack verification results file (quasi-permanent loads).

getVerifCrackRareFile()

Return the path of the crack verification results file (rare loads).

getVerifFatigueFile()

Return the path of the fatigue verification results file.

getVerifFile(limitStateLabel)

Return the path of the verification results file

for the limit state argument.

Parameters

limitStateLabel – label identifying the limit state.

getVerifNormStrFile()

Return the path of the normal stresses verification results file.

getVerifShearFile()

Return the path of the shear verification results file.

getVerifTorsionFile()

Return the path of the torsion verification results file.

getVerifVonMisesStressFile()

Return the path of the VonMisesStress verification results file.

makedirs(pth)

Recursive directory creation function. Like mkdir(), but

makes all intermediate-level directories needed to contain

the leaf directory.

Parameters

path – the path to create.

newResultsPath(folderName: str)

Creates a new folder inside the results directory.

Parameters

folderName – name for the new folder.

open(fileName, mode='r', buffering=- 1, encoding=None, errors=None, newline=None, closefd=True, opener=None)

Open file and return a corresponding file object..

Parameters

• fileName – the path and name of the file.

• mode – see Python documentation for open built-in function.

• bufferting – see Python documentation for open built-in function.

• encoding – see Python documentation for open built-in function.

• errors – see Python documentation for open built-in function.

• newline – see Python documentation for open built-in function.

• closefd – see Python documentation for open built-in function.

• opener – see Python documentation for open built-in function.

postprocess.config.default_config.compileCode(inputFile)

postprocess.config.default_config.findDirectoryUpwards(fNameMark: str)

Search upwards to find the directory where the file

argument is.

Parameters

fNameMark – name of the file that marks the directory we are searching for.

postprocess.config.default_config.findProjectDirectory(fNameMark='.git')

Search upwards to find the directory where the file

argument is.

Parameters

fNameMark – name of the file that marks the working directory.

postprocess.config.default_config.findWorkingDirectory(fNameMark='env_config.py')

Search upwards to find the directory where the file

argument is.

Parameters

fNameMark – name of the file that marks the working directory.

postprocess.config.default_config.find_directories(dirName, searchPath)

Return the occurrences of filename in search_path

Parameters

• dirName – name of the directory to search.

• searchPath – root directory to start the search.

postprocess.config.default_config.find_files(fileName, searchPath)

Return the occurrences of filename in search_path

Parameters

• fileName – name of the file to search.

• searchPath – root directory to start the search.

postprocess.config.default_config.get_temporary_env_config(subDirName: Optional[str] = None)

Return an EnvConvig object suitable for temporary storage of results, normally with testing purposes.

Parameters

subDirName – name of the folder where results will be stored.

postprocess.config.default_config.setWorkingDirectory(fNameMark='env_config.py')

Search upwards to find the directory where the file

argument is.

Parameters

fNameMark – name of the file that marks the working directory.