General topics

Output handler

class postprocess.output_handler.OutputHandler(modelSpace=None, outputStyle=<postprocess.output_styles.OutputStyle object>)

Bases: object

Object that handles the ouput (graphics, etc.)

Variables:
  • modelSpace – FE model data.
  • outputStyle – style of the output.
displayBeamResult(attributeName, itemToDisp, beamSetDispRes, setToDisplay=None, caption=None, fileName=None, defFScale=0.0)

display results for beam elements from a limit state verification file.

:param attributeName:attribute name(e.g. ‘ULS_normalStressesResistance’) :param itemToDisp: result item to display (e.g. ‘N’, ‘My’, …) :param beamSetDispRes:set of linear elements to which display results :param setToDisplay: set of elements (any type) to be depicted

(defaults to None, in that case only elements in beamSetDispRes are displayed)
Parameters:
  • caption – caption to display (defaults to ‘attributeName + itemToDisp’)
  • fileName – file to dump the display (defaults to screen display)
  • defFScale – factor to apply to current displacement of nodes so that the display position of each node equals to the initial position plus its displacement multiplied by this factor. (Defaults to 0.0, i.e. display of initial/undeformed shape)
displayBlocks(setToDisplay=None, caption=None, fileName=None)

Display the blocks (points, lines, surfaces and volumes) of the set.

Parameters:
  • setToDisplay – set to display.
  • caption – title of the graphic.
  • fileName – name of the file to plot the graphic. Defaults to None, in that case an screen display is generated
displayDiagram(attributeName, component, setToDispRes, setDisp, caption, scaleFactor=1.0, fileName=None, defFScale=0.0)

Auxiliary function to display results on linear elements.

Parameters:
  • attributeName – attribute name(e.g. ‘ULS_normalStressesResistance’)
  • component – result item to display (e.g. ‘N’, ‘My’, …)
  • setToDispRes – set of linear elements to which display results
  • setToDisplay – set of elements (any type) to be depicted
  • scaleFactor – factor of scale to apply to the auto-scaled display (defaults to 1)
  • caption – caption to display
  • fileName – file to dump the display
  • defFScale – factor to apply to current displacement of nodes so that the display position of each node equals to the initial position plus its displacement multiplied by this factor. (Defaults to 0.0, i.e. display of initial/undeformed shape)
displayDispRot(itemToDisp, setToDisplay=None, fileName=None, defFScale=0.0, rgMinMax=None)

displays the component of the displacement or rotations in the set of entities.

Parameters:
  • itemToDisp – component of the displacement (‘uX’, ‘uY’ or ‘uZ’) or the rotation (‘rotX’, rotY’, ‘rotZ’) to be depicted
  • setToDisplay – set of entities to be represented.
  • fileName – name of the file to plot the graphic. Defaults to None, in that case an screen display is generated
  • defFScale – factor to apply to current displacement of nodes so that the display position of each node equals to the initial position plus its displacement multiplied by this factor. (Defaults to 0.0, i.e. display of initial/undeformed shape)
  • rgMinMax – range (vmin,vmax) with the maximum and minimum values of the field to be represented. All the values less than vmin are displayed in blue and those greater than vmax in red (defaults to None)
displayEigenResult(eigenMode, setToDisplay=None, accelMode=None, caption='', fileName=None, defFScale=0.0)

Display the deformed shape and/or the equivalent static forces associated with the eigenvibration mode passed as parameter.

Parameters:
  • eigenMode – eigenvibration mode to be displayed
  • setToDisplay – set of elements to be displayed (defaults to total set)
  • accelMode – acceleration associated with the eigen mode depicted, only used if the equivalent static loads are to be displayed.
  • caption – text to display in the graphic
  • fileName – full name of the graphic file to generate. Defaults to ` None`, in this case it returns a console output graphic.
  • defFScale – factor to apply to deformed shape so that the displayed position of each node equals to the initial position plus its eigenVector multiplied by this factor. (Defaults to 0.0 i.e. display of initial/undeformed shape)
displayEigenvectors(mode=1, setToDisplay=None, caption=None, fileName=None, defFScale=0.0)

Displays the computed eigenvectors on the set argument.

Parameters:
  • setToDisplay – set of elements to be displayed (defaults to total set)
  • mode – mode to which the eigenvectors belong.
  • caption – text to display in the graphic. Defaults to ` None` in this case the text is the load case description and the units of the loads.
  • fileName – full name of the graphic file to generate. Defaults to ` None`, in this case it returns a console output graphic.,
  • defFScale – factor to apply to current displacement of nodes so that the display position of each node equals to the initial position plus its displacement multiplied by this factor. (Defaults to 0.0, i.e. display of initial/undeformed shape)
displayEigenvectorsOnSets(eigenMode, setsToDisplay, fileName=None, defFScale=0.0)

displays the reactions as vector on affected nodes

Parameters:
  • eigenMode – mode to which the eigenvectors belong.
  • setsToDisplay – sets to display on batch mode.
  • fileName – name of the file to plot the graphic. Defaults to None, in that case an screen display is generated
  • defFScale – factor to apply to current displacement of nodes so that the display position of each node equals to the initial position plus its displacement multiplied by this factor. (Defaults to 0.0, i.e. display of initial/undeformed shape)
displayElementValueDiagram(itemToDisp, setToDisplay=None, caption=None, fileName=None, defFScale=0.0)

displays the a displacement (uX,uY,…) or a property defined in nodes as a diagram over lines.

Parameters:
  • itemToDisp – item to display (uX,uY,…).
  • setToDisplay – set of entities (elements of type beam) to be represented
  • fileName – name of the file to plot the graphic. Defaults to None, in that case an screen display is generated
  • defFScale – factor to apply to current displacement of nodes so that the display position of each node equals to the initial position plus its displacement multiplied by this factor. (Defaults to 0.0, i.e. display of initial/undeformed shape)
displayFEMesh(setsToDisplay=None, caption=None, fileName=None, defFScale=0.0)

Display the mesh (nodes, elements and constraints) of the set.

Parameters:
  • setsToDisplay – list of sets to display (defaults to TotalSet).
  • caption – title of the graphic.
  • fileName – name of the file to plot the graphic. Defaults to None, in that case an screen display is generated
  • defFScale – factor to apply to current displacement of nodes so that the display position of each node equals to the initial position plus its displacement multiplied by this factor. (Defaults to 0.0, i.e. display of initial/undeformed shape)
displayFieldDirs1and2(limitStateLabel, argument, component, setToDisplay, fileName, defFScale=0.0, rgMinMax=None)
Display a field defined over bi-dimensional elements in its two
directions.
Parameters:
  • limitStateLabel – label that identifies the limit state.
  • argument – name of the control var to represent.
  • component – component of the control var to represent.
  • setToDisplay – represent the field over those elements.
  • fileName – file name to store the image. If none -> window on screen.
  • defFScale – factor to apply to current displacement of nodes so that the display position of each node equals to the initial position plus its displacement multiplied by this factor. (Defaults to 0.0, i.e. display of initial/undeformed shape)
  • rgMinMax – range (vmin,vmax) with the maximum and minimum values of the scalar field (if any) to be represented. All the values less than vmin are displayed in blue and those greater than vmax in red (defaults to None)
displayIntForc(itemToDisp, setToDisplay=None, fileName=None, defFScale=0.0, rgMinMax=None)

displays the component of internal forces in the set of entities as a scalar field (i.e. appropiated for 2D elements; shells…).

Parameters:
  • itemToDisp – component of the internal forces (‘N1’, ‘N2’, ‘N12’, ‘M1’, ‘M2’, ‘M12’, ‘Q1’, ‘Q2’) to be depicted
  • setToDisplay – set of entities to be represented (default to all entities)
  • fileName – name of the file to plot the graphic. Defaults to None, in that case an screen display is generated
  • defFScale – factor to apply to current displacement of nodes so that the display position of each node equals to the initial position plus its displacement multiplied by this factor. (Defaults to 0.0, i.e. display of initial/undeformed shape)
  • rgMinMax – range (vmin,vmax) with the maximum and minimum values of the field to be represented. All the values less than vmin are displayed in blue and those greater than vmax in red (defaults to None)
displayIntForcDiag(itemToDisp, setToDisplay=None, fileName=None, defFScale=0.0)
displays the component of internal forces in the set of entities as a
diagram over lines (i.e. appropiated for beam elements).
Parameters:
  • itemToDisp – component of the internal forces (‘N’, ‘Qy’ (or ‘Vy’), ‘Qz’ (or ‘Vz’), ‘My’, ‘Mz’, ‘T’) to be depicted
  • setToDisplay – set of entities (elements of type beam) to be represented
  • fileName – name of the file to plot the graphic. Defaults to None, in that case an screen display is generated
  • defFScale – factor to apply to current displacement of nodes so that the display position of each node equals to the initial position plus its displacement multiplied by this factor. (Defaults to 0.0, i.e. display of initial/undeformed shape)
displayLoadVectors(setToDisplay=None, caption=None, fileName=None, defFScale=0.0)

Displays load vectors on the set argument.

Parameters:
  • setToDisplay – set of elements to be displayed (defaults to total set)
  • caption – text to display in the graphic. Defaults to ` None` in this case the text is the load case description and the units of the loads.
  • fileName – full name of the graphic file to generate. Defaults to ` None`, in this case it returns a console output graphic.,
  • defFScale – factor to apply to current displacement of nodes so that the display position of each node equals to the initial position plus its displacement multiplied by this factor. (Defaults to 0.0, i.e. display of initial/undeformed shape)
displayLoads(setToDisplay=None, elLoadComp='xyzComponents', fUnitConv=1, caption=None, fileName=None, defFScale=0.0)

Display the loads applied on beam elements and nodes for a given load case

Parameters:
  • setToDisplay – set of beam elements to be represented (defaults to TotalSet)
  • elLoadComp

    component of the loads on elements to be depicted [possible components: ‘axialComponent’, ‘transComponent’,

    ’transYComponent’, ‘transZComponent’,’xyzComponents’]
  • fUnitConv – factor of conversion to be applied to the results (defaults to 1)
  • caption – caption for the graphic
  • fileName – name of the file to plot the graphic. Defaults to None, in that case an screen display is generated
  • defFScale – factor to apply to current displacement of nodes so that the display position of each node equals to the initial position plus its displacement multiplied by this factor. (Defaults to 0.0, i.e. display of initial/undeformed shape)
displayLocalAxes(setToDisplay=None, caption=None, fileName=None, defFScale=0.0)

Display the local axes of the elements contained in the set.

Parameters:
  • setToDisplay – set to display.
  • caption – title of the graphic.
  • fileName – name of the file to plot the graphic. Defaults to None, in that case an screen display is generated
  • defFScale – factor to apply to current displacement of nodes so that the display position of each node equals to the initial position plus its displacement multiplied by this factor. (Defaults to 0.0, i.e. display of initial/undeformed shape)
displayNodeValueDiagram(itemToDisp, setToDisplay=None, caption=None, fileName=None, defFScale=0.0)

displays the a displacement (uX,uY,…) or a property defined in nodes as a diagram over lines.

Parameters:
  • itemToDisp – item to display (uX,uY,…).
  • setToDisplay – set of entities (elements of type beam) to be represented
  • fileName – name of the file to plot the graphic. Defaults to None, in that case an screen display is generated
  • defFScale – factor to apply to current displacement of nodes so that the display position of each node equals to the initial position plus its displacement multiplied by this factor. (Defaults to 0.0, i.e. display of initial/undeformed shape)
displayReactions(setToDisplay=None, fileName=None, defFScale=0.0)

Display reactions.

Parameters:
  • setToDisplay – set of entities to be represented.
  • fileName – name of the file to plot the graphic. Defaults to None, in that case an screen display is generated
  • defFScale – factor to apply to current displacement of nodes so that the display position of each node equals to the initial position plus its displacement multiplied by this factor. (Defaults to 0.0, i.e. display of initial/undeformed shape)
displayScalarPropertyAtNodes(propToDisp, fUnitConv, unitDescription, captionText, setToDisplay, fileName=None, defFScale=0.0, rgMinMax=None)

displays the scalar property defined at the nodes of the set.

Parameters:
  • propeToDisp – scalar property defined at nodes.
  • fUnitConv – conversion factor for units
  • unitDescription – unit(s) symbol(s)
  • setToDisplay – set of entities to be represented.
  • fileName – name of the file to plot the graphic. Defaults to None, in that case an screen display is generated
  • defFScale – factor to apply to current displacement of nodes so that the display position of each node equals to the initial position plus its displacement multiplied by this factor. (Defaults to 0.0, i.e. display of initial/undeformed shape)
  • rgMinMax – range (vmin,vmax) with the maximum and minimum values of the field to be represented. All the values less than vmin are displayed in blue and those greater than vmax in red (defaults to None)
displayStrains(itemToDisp, setToDisplay=None, fileName=None, defFScale=0.0, rgMinMax=None)

displays the strains on the elements.

Parameters:
  • itemToDisp – component of the stress (‘eps_11’, ‘eps_22’…)
  • setToDisplay – set of entities to be represented.
  • fileName – name of the file to plot the graphic. Defaults to None, in that case an screen display is generated
  • defFScale – factor to apply to current displacement of nodes so that the display position of each node equals to the initial position plus its displacement multiplied by this factor. (Defaults to 0.0, i.e. display of initial/undeformed shape)
  • rgMinMax – range (vmin,vmax) with the maximum and minimum values of the field to be represented. All the values less than vmin are displayed in blue and those greater than vmax in red (defaults to None)
displayStresses(itemToDisp, setToDisplay=None, fileName=None, defFScale=0.0, rgMinMax=None)

display the stresses on the elements.

Parameters:
  • itemToDisp – component of the stress (‘sigma_11’, ‘sigma_22’…)
  • setToDisplay – set of entities to be represented.
  • fileName – name of the file to plot the graphic. Defaults to None, in that case an screen display is generated
  • defFScale – factor to apply to current displacement of nodes so that the display position of each node equals to the initial position plus its displacement multiplied by this factor. (Defaults to 0.0, i.e. display of initial/undeformed shape)
  • rgMinMax – range (vmin,vmax) with the maximum and minimum values of the field to be represented. All the values less than vmin are displayed in blue and those greater than vmax in red (defaults to None)
displayStrongWeakAxis(setToDisplay=None, caption=None, fileName=None, defFScale=0.0)

Display the local axes of the elements contained in the set.

Parameters:
  • setToDisplay – set to display.
  • caption – title of the graphic.
  • fileName – name of the file to plot the graphic. Defaults to None, in that case an screen display is generated
  • defFScale – factor to apply to current displacement of nodes so that the display position of each node equals to the initial position plus its displacement multiplied by this factor. (Defaults to 0.0, i.e. display of initial/undeformed shape)
getCameraParameters()

Return a suitable set of camera parameters if not already defined.

getCaptionText(itemToDisp, unitDescription, setToDisplay)

Return the text to use in the image caption.

getDefaultCameraParameters()

Return the default camera parameters.

Output styles

class postprocess.output_styles.OutputStyle(cameraParameters=None, outputUnits=<postprocess.output_units.OutputUnits object>, constraintsScaleFactor=0.4, localAxesVectorScaleFactor=0.5, language=None)

Bases: object

Pararameters used in the output routines (graphics, etc.)

Variables:
  • cameraParameters – camera position and orientation.
  • outputUnits – output units and unit conversion.
  • constraintsScaleFactor – scale factor to display DOF constraints.
  • localAxesVectorScaleFactor – scale factor to display local axes vectors.
  • reactionVectorScaleFactor – scale factor to display reactions.
  • eigenvectorScaleFactor – scale factor to display eigenvectors.
  • equivalentLoadVectorsScaleFactor – factor to apply to the vectors length in the representation of equivalent loads on nodes. If vectorEqLoadScale equals 0, equivalent static loads are not represented. (defaults to 0.0 in which case only deformed shape is depicted)
  • loadVectorsScaleFactor – factor to apply to the vectors length in the representation of element loads (defaults to 1).
  • loadDiagramsScaleFactor – scale factor to apply to the diagram display of element loads (defaults to 1).
  • showLoadsPushing – true if the vector ends in the loaded node (push the node).
  • multByElemAreaLoads – boolean value that must be True if we want to represent the total load on each element (=load multiplied by element area) and False if we are going to depict the value of the uniform load per unit area (defaults to False)
  • language – english, spanish, french
  • directionDescr – text list to identify each direction (as [‘vertical reinforcement’, ‘horizontal reinforcement’]).
Iver nodalLoadBarOrientation:
 

orientation of scale bar for nodal loads ‘H’ -> horizontal, ‘V’ -> vertical

getCaptionTextsDict()

Return a dictionary with the caption texts to use in graphic output.

getDisplacementUnitsDescription()

Return the description for the displacement units.

getDisplacementUnitsScaleFactor()

Return the scale factor for the displacement units.

getForceUnitsDescription()

Return the description for the displacement units.

getForceUnitsScaleFactor()

Return the scale factor for the displacement units.

getPressureUnitsDescription()

Return the description for the displacement units.

getPressureUnitsScaleFactor()

Return the scale factor for the displacement units.

getRotationUnitsDescription()

Return the descrioption for the displacement units.

getRotationUnitsScaleFactor()

Return the scale factor for the displacement units.

getUnitParameters(itemToDisp)
Return the pair (scale factor, description) for
the argument parameter.
Parameters:itemToDisp – item to display (uX, uY, N, Mz,…).

Output units

class postprocess.output_units.DisplacementUnits(lengthUnit=<postprocess.output_units.UnitDefinitionPair object>, planeAngleUnit=<postprocess.output_units.UnitDefinitionPair object>)

Bases: object

Units to use for the output of displacement magnitudes

Variables:
  • lengthUnit – unit to express lengths.
  • planeAngleUnit – unit to express angles.
getDecoratedDisplSymbol()
getDecoratedRotSymbol()
class postprocess.output_units.DynamicsUnits(forceUnit=<postprocess.output_units.UnitDefinitionPair object>, lengthUnit=<postprocess.output_units.UnitDefinitionPair object>, pressureUnit=<postprocess.output_units.UnitDefinitionPair object>)

Bases: object

Units to use for the output of forces

Variables:
  • forceUnit – unit to express forces.
  • lengthUnit – unit to express lengths.
getDecoratedForceUnitsText()
getDecoratedPressureUnitsText()
class postprocess.output_units.OutputUnits(displacementUnits=<postprocess.output_units.DisplacementUnits object>, dynamicUnits=<postprocess.output_units.DynamicsUnits object>)

Bases: object

Units to use in output stuff (graphics, etc.)

Variables:
  • displacementUnits – units for the displacements
  • dynamicUnits – units for the forces and moments
getDisplacementUnitsDescription()

Return the description for the displacement units.

getDisplacementUnitsScaleFactor()

Return the scale factor for the displacement units.

getForceUnitsDescription()

Return the description for the displacement units.

getForceUnitsScaleFactor()

Return the scale factor for the displacement units.

getPressureUnitsDescription()

Return the description for the displacement units.

getPressureUnitsScaleFactor()

Return the scale factor for the displacement units.

getRotationUnitsDescription()

Return the description for the displacement units.

getRotationUnitsScaleFactor()

Return the scale factor for the displacement units.

class postprocess.output_units.UnitDefinitionPair(symbol, scaleFactor, quantity)

Bases: object

Text symbol describing the unit (kN,lb,N,m,mm,in, etc) and scale factor to apply to the results in order to obtain the desired output units (i.e.: N->kN scaleUnitsForce: 1e-3).

Variables:
  • symbol – symbol of the unit
  • scaleFactor – scale factor to apply to the results in order to obtain the desired output units (i.e.: N->kN scaleUnitsForce: 1e-3).
getDecoratedSymbol()

Return the symbol between brackets.

Callback controls

postprocess.callback_controls.controTensRecElastico2d()

Code to execute in every commit to check stress criterion (bars in plane problems).

postprocess.callback_controls.controTensRecElastico3d()

Code to execute in every commit to check stress criterion (bars in 3D problems).

postprocess.callback_controls.controlMovModulusUV()
postprocess.callback_controls.controlMovModulusUVW()
postprocess.callback_controls.controlMovU()
postprocess.callback_controls.controlMovUV()
postprocess.callback_controls.controlMovUVW()
postprocess.callback_controls.controlMovV()
postprocess.callback_controls.controlMovW()
postprocess.callback_controls.controlMovs()
postprocess.callback_controls.fnControlMovComponent(recorder, obj, codeComponent, value)
postprocess.callback_controls.fnControlMovUVW(recorder, obj)
postprocess.callback_controls.fnControlMovs(recorder, obj)

Control variables

class postprocess.control_vars.AISCBiaxialBendingControlVars(idSection='nil', combName='nil', CF=-1.0, N=0.0, My=0.0, Mz=0.0, Ncrd=0.0, McRdy=0.0, McRdz=0.0, MvRdz=0.0, MbRdz=0.0, chiLT=1.0, chiN=1.0)

Bases: postprocess.control_vars.SSBiaxialBendingControlVars

Control variables for biaxial bending normal stresses LS verification in steel-shape elements according to AISC.

Variables:chiN – reduction factor for compressive strength (defaults to 1)
getLaTeXFields(factor=0.001)

Returns a string with the intermediate fields of the LaTeX string.

Parameters:factor – factor for units (default 1e-3 -> kN)
getStrArguments()

Returns a string for a ‘copy’ (kind of) constructor.

class postprocess.control_vars.AxialForceControlVars(idSection='nil', combName='nil', N=0.0)

Bases: postprocess.control_vars.ControlVarsBase

Axial force. Internal forces [N] for a combination.

Variables:
  • idSection – section identifier
  • combName – name of the load combinations to deal with
  • N – axial force (defaults to 0.0)
getAnsysStrings(eTag, axis, factor=0.001)

Returns a string to represent fields in ANSYS (R).

Parameters:
  • eTag – element identifier.
  • axis – section 1 or 2
  • factor – factor for units (default 1e-3 -> kN)
getLaTeXFields(factor=0.001)

Returns a string with the intermediate fields of the LaTeX string.

Parameters:factor – factor for units (default 1e-3 -> kN)
getStrArguments()

Returns a string for a ‘copy’ (kind of) constructor.

class postprocess.control_vars.BiaxialBendingControlVars(idSection='nil', combName='nil', CF=-1.0, N=0.0, My=0.0, Mz=0.0)

Bases: postprocess.control_vars.UniaxialBendingControlVars

Biaxial bending. Normal stresses limit state variables. [CF,N,My,Mz].

Variables:
  • idSection – section identifier
  • combName – name of the load combinations to deal with
  • CF – capacity factor (efficiency) (defaults to -1)
  • N – axial force (defaults to 0.0)
  • My – bending moment about Y axis (defaults to 0.0)
  • Mz – bending moment about Z axis (defaults to 0.0)
getAnsysStrings(eTag, axis, factor=0.001)

Returns a string to represent fields in ANSYS (R).

Parameters:
  • eTag – element identifier.
  • axis – section 1 or 2
  • factor – factor for units (default 1e-3 -> kN)
getLaTeXFields(factor=0.001)

Returns a string with the intermediate fields of the LaTeX string.

Parameters:factor – factor for units (default 1e-3 -> kN)
getStrArguments()

Returns a string for a ‘copy’ (kind of) constructor.

class postprocess.control_vars.CFNMy(combName='nil', CF=-1.0, N=0.0, My=0.0)

Bases: postprocess.control_vars.NMy

Uniaxial bending. Normal stresses limit state variables.

Variables:
  • combName – name of the load combinations to deal with
  • CF – capacity factor (efficiency) (defaults to -1.0; CF<1.0 -> Ok; CF>1.0 -> KO)
  • N – axial force (defaults to 0.0)
  • My – bending moment about Y axis (defaults to 0.0)
  • Mz – bending moment about Z axis (defaults to 0.0)
getCF()
class postprocess.control_vars.CFNMyMz(combName='nil', CF=-1.0, N=0.0, My=0.0, Mz=0.0)

Bases: postprocess.control_vars.CFNMy

Biaxial bending. Normal stresses limit state variables. [CF,N,My,Mz].

Variables:
  • combName – name of the load combinations to deal with
  • CF – capacity factor (efficiency) (defaults to -1)
  • N – axial force (defaults to 0.0)
  • My – bending moment about Y axis (defaults to 0.0)
  • Mz – bending moment about Y axis (defaults to 0.0)
getAnsysStrings(eTag, axis, factor=0.001)

Returns a string to represent fields in ANSYS (R).

Parameters:
  • eTag – element identifier.
  • axis – section 1 or 2
  • factor – factor for units (default 1e-3 -> kN)
getLaTeXFields(factor=0.001)

Returns a string with the intermediate fields of the LaTeX string.

Parameters:factor – factor for units (default 1e-3 -> kN)
getStrArguments()

Returns a string for a ‘copy’ (kind of) constructor.

class postprocess.control_vars.CFVy(combName='nil', CF=-1.0, Vy=0.0)

Bases: postprocess.control_vars.ShVy

Uniaxial bending. Normal stresses limit state variables.

Variables:
  • combName – name of the load combinations to deal with
  • CF – capacity factor (efficiency) (defaults to -1.0; CF<1.0 -> Ok; CF>1.0 -> KO)
  • Vy – shear along Y axis (defaults to 0.0)
getCF()
class postprocess.control_vars.ControlVarsBase(combName='nil')

Bases: object

Base class for the control of variables (internal forces,
strains, stresses,…) calculated in the analysis.
Variables:combName – name of the load combination to deal with
getAnsysStrings(eTag, axis, factor=0.001)

Returns a string to represent fields in ANSYS (R).

Parameters:
  • eTag – element identifier.
  • axis – section 1 or 2
  • factor – factor for units (default 1e-3 -> kN)
getCF()
getFieldNames(parent='')
getLaTeXFields(factor=0.001)

Returns a string with the intermediate fields of the LaTeX string.

Parameters:factor – factor for units (default 1e-3 -> kN)
getLaTeXString(eTag, factor=0.001)

Returns a string that we can insert in a LaTeX table.

Parameters:
  • eTag – element identifier.
  • factor – factor for units (default 1e-3 -> kN)
getStrArguments()

Returns a string for a ‘copy’ (kind of) constructor.

getStrConstructor()
strElementProp(eTag, nmbProp)

Writes a string that will serve to read the element property from a file.

Parameters:
  • eTag – element identifier.
  • nmbProp – name of the element property
class postprocess.control_vars.CrackControlBaseVars(combName='nil', CF=-1.0, N=0.0, My=0.0, Mz=0.0, steelStress=0.0)

Bases: postprocess.control_vars.CFNMyMz

Biaxial bending. Cracking serviceability limit state variables.

Variables:
  • combName – name of the load combinations to deal with
  • CF – capacity factor (efficiency)
  • N – axial force
  • My – bending moment about Y axis
  • Mz – bending moment about Z axis
  • steelStress – maximum stress in the reinforcement bars
getAnsysStrings(eTag, axis, factor=0.001)

Returns a string to represent fields in ANSYS (R).

Parameters:
  • eTag – element identifier.
  • axis – section 1 or 2
  • factor – factor for units (default 1e-3 -> kN)
getLaTeXFields(factor=0.001)

Returns a string with the intermediate fields of the LaTeX string.

Parameters:factor – factor for units (default 1e-3 -> kN)
getStrArguments()

Returns a string for a ‘copy’ (kind of) constructor.

class postprocess.control_vars.CrackControlVars(idSection='nil', crackControlBaseVarsPos=None, crackControlBaseVarsNeg=None)

Bases: postprocess.control_vars.ControlVarsBase

Cracking serviceability limit state control variables.

Variables:
  • idSection – section identifier
  • crackControlVarsPos – Crack control in + face.
  • crackControlVarsNeg – Crack control in - face.
getCF()
getLaTeXFields(factor=0.001)

Returns a string with the intermediate fields of the LaTeX string. factor: factor for units (default 1e-3 -> kN)

getMaxN()

Maximum internal axial force.

getMaxSteelStress()

Maximum value for rebar stresses.

getStrArguments()

Returns a string for a ‘copy’ (kind of) constructor.

class postprocess.control_vars.FatigueControlBaseVars(combName='nil', CF=-1.0, N=0.0, My=0.0, Mz=0.0, Vy=0.0, posSteelStress=0.0, negSteelStress=0.0, concreteStress=0.0)

Bases: postprocess.control_vars.NMyMz

Biaxial bending. Fatigue limit state variables.

Variables:
  • combName – name of the load combinations to deal with
  • N – axial force (defaults to 0.0)
  • My – bending moment about Y axis (defaults to 0.0)
  • Mz – bending moment about Z axis (defaults to 0.0)
  • Vy – shear force parallel to Y axis.
  • posSteelStress – traction stress in rebars.
  • negSteelStress – compression stress in rebars.
  • concreteStress – compression stress in concrete.
getAnsysStrings(eTag, axis, factor=0.001)

Returns a string to represent fields in ANSYS (R).

Parameters:
  • eTag – element identifier.
  • axis – section 1 or 2
  • factor – factor for units (default 1e-3 -> kN)
getLaTeXFields(factor=0.001)

Returns a string with the intermediate fields of the LaTeX string.

Parameters:factor – factor for units (default 1e-3 -> kN)
getStrArguments()

Returns a string for a ‘copy’ (kind of) constructor.

class postprocess.control_vars.FatigueControlVars(idSection='nil', controlBaseVars0=None, controlBaseVars1=None, concreteLimitStress=0.0, concreteBendingCF=-1.0, shearLimit=0.0, concreteShearCF=-1.0, Mu=0.0, Vu=0.0)

Bases: postprocess.control_vars.ControlVarsBase

Fatigue limit state control variables.

Variables:
  • idSection – section identifier
  • combName – name of the load combinations to deal with
  • state0 – Fatigue values (FatigueControlBaseVars) under permanent load.
  • state1 – Fatigue values (FatigueControlBaseVars) under fatigue load.
  • concreteLimitStress – limit for the concrete stress as specified in SIA 262(2013) 4.3.8.3.1
  • concreteBendingCF – concrete capacity factor under fatigue due to normal stresses.
  • shearLimit – limit for the shear force as sepecified in SIA 262(2013) 4.3.8.3.2
  • concreteShearCF – concrete capacity factor under fatigue due to shear forces.
  • Mu – ultimate bending moment
  • Vu – ultimate shear force
getAbsSteelStressIncrement()

Returns maximun stress increment in rebars (absolute value).

getConcreteMaxMinStresses()

Used in FatigueController.concreteLimitStress.

getConcreteMinStress()

Returns minimum (max. compressive) concrete stress between loaded and unloaded states.

getConcreteStressIncrement()

Returns stress increment in concrete.

getLaTeXFields(factor=0.001)

Returns a string with the intermediate fields of the LaTeX string.

Parameters:factor – factor for units (default 1e-3 -> kN)
getSteelNegStressIncrement()

Returns negative stress increment in rebars.

getSteelPosStressIncrement()

Returns positive stress increment in rebars.

getStrArguments()

Returns a string for a ‘copy’ (kind of) constructor.

class postprocess.control_vars.NMy(combName='nil', N=0.0, My=0.0)

Bases: postprocess.control_vars.ControlVarsBase

Uniaxial bending. Internal forces [N,My] for a combination.

Variables:
  • combName – name of the load combinations to deal with
  • N – axial force (defaults to 0.0)
  • My – bending moment about Y axis (defaults to 0.0)
getAnsysStrings(eTag, axis, factor=0.001)

Returns a string to represent fields in ANSYS (R).

Parameters:
  • eTag – element identifier.
  • axis – section 1 or 2
  • factor – factor for units (default 1e-3 -> kN)
getLaTeXFields(factor=0.001)

Returns a string with the intermediate fields of the LaTeX string.

Parameters:factor – factor for units (default 1e-3 -> kN)
getStrArguments()

Returns a string for a ‘copy’ (kind of) constructor.

class postprocess.control_vars.NMyMz(combName='nil', N=0.0, My=0.0, Mz=0.0)

Bases: postprocess.control_vars.NMy

Biaxial bending. Internal forces [N,My,Mz] for a combination.

Variables:
  • combName – name of the load combinations to deal with
  • N – axial force (defaults to 0.0)
  • My – bending moment about Y axis (defaults to 0.0)
  • Mz – bending moment about Z axis (defaults to 0.0)
getAnsysStrings(eTag, axis, factor=0.001)

Returns a string to represent fields in ANSYS (R).

Parameters:
  • eTag – element identifier.
  • axis – section 1 or 2
  • factor – factor for units (default 1e-3 -> kN)
getLaTeXFields(factor=0.001)

Returns a string with the intermediate fields of the LaTeX string.

Parameters:factor – factor for units (default 1e-3 -> kN)
getStrArguments()

Returns a string for a ‘copy’ (kind of) constructor.

class postprocess.control_vars.RCCrackStraightControlVars(idSection=-1, combName='nil', CF=-1, N=0.0, My=0.0, Mz=0.0, s_rmax=0.0, eps_sm=0.0, wk=0.0)

Bases: postprocess.control_vars.NMyMz

Control variables for cracking serviacebility limit state verification when when considering a concrete stress-strain diagram that takes account of the effects of tension stiffening.

Variables:
  • idSection – section identifier
  • combName – name of the load combinations to deal with
  • N – axial force
  • My – bending moment about Y axis
  • Mz – bending moment about Z axis
  • s_rmax – maximum distance between cracks (otherwise a new crack could occur in-between
  • eps_sm – mean strain in the reinforcement when taking into account the effects of tension stiffening
  • wk – crack width
getLaTeXFields(factor=0.001)

Returns a string with the intermediate fields of the LaTeX string.

Parameters:factor – factor for units (default 1e-3 -> kN)
getStrArguments()

Returns a string for a ‘copy’ (kind of) constructor.

class postprocess.control_vars.RCShearControlVars(idSection=-1, combName='nil', CF=-1.0, N=0.0, My=0.0, Mz=0.0, Mu=0.0, Vy=0.0, Vz=0.0, theta=0.0, Vcu=0.0, Vsu=0.0, Vu=0.0)

Bases: postprocess.control_vars.BiaxialBendingControlVars

Control variables for shear limit state verification in reinforced concrete elements.

Variables:
  • idSection – section identifier
  • combName – name of the load combinations to deal with
  • CF – capacity factor (efficiency)
  • N – axial force
  • My – bending moment about Y axis
  • Mz – bending moment about Z axis
  • Mu – ultimate bending moment
  • Vy – shear force parallel to the y axis
  • Vz – shear force parallel to the z axis
  • theta – angle between the concrete compression struts and the beam axis
  • Vcu – Vcu component of the shear strength (defined in the codes)
  • Vsu – Vsu component of the shear strength (defined in the codes)
  • Vu – shear strength
getAnsysStrings(eTag, axis, factor=0.001)

Returns a string to represent fields in ANSYS (R).

Parameters:
  • eTag – element identifier.
  • axis – section 1 or 2
  • factor – factor for units (default 1e-3 -> kN)
getLaTeXFields(factor=0.001)

Returns a string with the intermediate fields of the LaTeX string.

Parameters:factor – factor for units (default 1e-3 -> kN)
getStrArguments()

Returns a string for a ‘copy’ (kind of) constructor.

class postprocess.control_vars.SSBiaxialBendingControlVars(idSection='nil', combName='nil', CF=-1.0, N=0.0, My=0.0, Mz=0.0, Ncrd=0.0, McRdy=0.0, McRdz=0.0, MvRdz=0.0, MbRdz=0.0, chiLT=1.0)

Bases: postprocess.control_vars.BiaxialBendingControlVars

Control variables for biaxial bending normal stresses LS verification en steel-shape elements.

Variables:
  • idSection – section identifier
  • combName – name of the load combinations to deal with
  • CF – capacity factor (efficiency) (defaults to -1)
  • N – axial force (defaults to 0.0)
  • My – bending moment about Y (weak) axis (defaults to 0.0)
  • Mz – bending moment about Z (strong) axis (defaults to 0.0)
  • Ncrd – design strength to axial compression
  • McRdy – design moment strength about Y (weak) axis
  • McRdz – design moment strength about Z (strong) axis
  • MvRdz – reduced design moment strength about Z (strong) axis for shear interaction
  • MbRdz – reduced design moment strength about Z (strong) axis for lateral-torsional bucking
  • chiLT – reduction factor for lateral-torsional buckling (defaults to 1)
getLaTeXFields(factor=0.001)

Returns a string with the intermediate fields of the LaTeX string.

Parameters:factor – factor for units (default 1e-3 -> kN)
getStrArguments()

Returns a string for a ‘copy’ (kind of) constructor.

class postprocess.control_vars.ShVy(combName='nil', Vy=0.0)

Bases: postprocess.control_vars.ControlVarsBase

Shear along Y axis. Internal forces [Vy] for a combination.

Variables:
  • combName – name of the load combinations to deal with
  • Vy – bending moment about Y axis (defaults to 0.0)
getAnsysStrings(eTag, axis, factor=0.001)

Returns a string to represent fields in ANSYS (R).

Parameters:
  • eTag – element identifier.
  • axis – section 1 or 2
  • factor – factor for units (default 1e-3 -> kN)
getLaTeXFields(factor=0.001)

Returns a string with the intermediate fields of the LaTeX string.

Parameters:factor – factor for units (default 1e-3 -> kN)
getStrArguments()

Returns a string for a ‘copy’ (kind of) constructor.

class postprocess.control_vars.ShearYControlVars(idSection='nil', combName='nil', CF=-1.0, Vy=0.0)

Bases: postprocess.control_vars.CFVy

Shear along Y axis. Limit state variables [CF,Vy].

Variables:
  • idSection – section identifier
  • combName – name of the load combinations to deal with
  • CF – capacity factor (efficiency) (defaults to -1; CF<1.0 -> Ok; CF>1.0 -> KO)
  • Vy – shear along Y axis (defaults to 0.0)
getLaTeXFields(factor=0.001)

Returns a string with the intermediate fields of the LaTeX string.

Parameters:factor – factor for units (default 1e-3 -> kN)
getStrArguments()

Returns a string for a ‘copy’ (kind of) constructor.

class postprocess.control_vars.UniaxialBendingControlVars(idSection='nil', combName='nil', CF=-1.0, N=0.0, My=0.0)

Bases: postprocess.control_vars.CFNMy

Uniaxial bending. Normal stresses limit state variables [CF,N,My].

Variables:
  • idSection – section identifier
  • combName – name of the load combinations to deal with
  • CF – capacity factor (efficiency) (defaults to -1; CF<1.0 -> Ok; CF>1.0 -> KO)
  • N – axial force (defaults to 0.0)
  • My – bending moment about Y axis (defaults to 0.0)
getLaTeXFields(factor=0.001)

Returns a string with the intermediate fields of the LaTeX string.

Parameters:factor – factor for units (default 1e-3 -> kN)
getStrArguments()

Returns a string for a ‘copy’ (kind of) constructor.

postprocess.control_vars.extrapolate_control_var(elemSet, propName, argument, initialValue=0.0)

Extrapolates element’s function values to the nodes.

Parameters:
  • elemSet – set of elements.
  • propName – name of the property that contains the control variables.
  • function – name of the function to call for each element.
  • argument – name of the control variable to extrapolate.
  • initialValue – initial value for the prop defined at the nodes.
postprocess.control_vars.writeControlVarsFromElements(controlVarName, preprocessor, outputFileName, outputCfg)

Writes in file ‘outputFileName’ the control-variable values calculated for elements in set ‘setCalc’.

Parameters:
  • controlVarName – name of the control var (e.g. ‘ULS_normalStressesResistance’ )
  • preprocessor – preprocessor from FEA model.
  • outputFileName – name of the files to write (.py and .tex)
  • outputCfg – instance of class ‘VerifOutVars’ which defines the variables that control the output of the checking (set of elements to be analyzed [defaults to ‘total’], append or not the results to the result file [defatults to ‘N’], generation or not of list file [defatults to ‘N’, …)
postprocess.control_vars.writeControlVarsFromElementsForAnsys(controlVarName, preprocessor, outputFileName, sectionName1, sectionName2)
Parameters:
  • preprocessor – preprocessor name
  • outputFileName – name of the output file containing tue results of the verification
postprocess.control_vars.writeControlVarsFromPhantomElements(controlVarName, preprocessor, outputFileName, outputCfg)
Writes in file ‘outputFileName’ the control-variable values calculated for
the RC elements in the phantom model.
Parameters:
  • controlVarName – name of the control var.
  • preprocessor – preprocessor from FEA model.
  • outputFileName – name to the files (.py and .tex)
  • outputCfg – instance of class ‘VerifOutVars’ which defines the variables that control the output of the checking (append or not the results to a file, generation or not of lists, …)

Control variables definition

THIS PROPERTIES MUST BE REPLACED BY THE CLASSES DEFINED IN control_vars.py THIS FILE MUST DISSAPEAR.

postprocess.def_vars_control.defSteelShapeElasticRangeElementParameters(e, shape)
postprocess.def_vars_control.defSteelShapeElasticRangeParametersForSet(elems, shape)
postprocess.def_vars_control.defVarControlMov(obj, code)
postprocess.def_vars_control.defVarsControlMovModulus(nodes)
postprocess.def_vars_control.defVarsControlMovs(nodes, flags)
postprocess.def_vars_control.defVarsControlTensRegElastico2d(elems)
postprocess.def_vars_control.defVarsControlTensRegElastico3d(elems)
postprocess.def_vars_control.defVarsEnvelopeInternalForcesBeamElems(elems)

Defines properties to store extreme values of internal forces.

postprocess.def_vars_control.updateEnvelopeInternalForcesBeamElem(beamElem)

Update values for extreme values of internal forces.

postprocess.def_vars_control.updateEnvelopeInternalForcesBeamElem2D(beamElem2D)

Update values for extreme values of internal forces in 2D elements.

Displayable_results

class postprocess.displayable_results.ResultDescription(attributeName, argument, description, units='')

Bases: object

getCaption()
getReinforcementLabel()
class postprocess.displayable_results.ResultsDescriptionContainer(limitStateData, lst)

Bases: dict

Results to display as figures.

Variables:limitStateData – string defining limit state check label (something like “Fatigue” or “CrackControl”) and the name of the file that contains the results to display. :ivar lst: list of results descriptions.
add(rd)
display(tp, partToDisplay)

Calls TakePhoto object tp to display figures corresponding to part.

Parameters:partToDisplay – part of the model that will be displayed.
getBaseOutputFileName(partCode)

Returns the basic part of the output file names.

getFigureDefinitionList(partToDisplay)

Builds a list of figures to display.

param: partToDisplay: part of the model wich will be displayed

getLaTeXFigureListFileName(partCode)

Return the name of the LaTeX file to write a list explaining figures.

getLaTeXOutputFileName(partCode)

Return the name of the LaTeX file to write figures into.

Element section map

class postprocess.element_section_map.ElementSectionMap

Bases: dict

dictionary that stores a section name(s) for each element number. This way it defines a spatial distribution of the sections over the structure.

assign(elemSet, setRCSects)

Assigns the sections names: setRCSectsName+‘1’, setRCSectsName+‘2’, … to the elements of the set.

Parameters:
  • elemSet – set of elements that receive the section name property.
  • setRCSects – RC section definition, name, concrete type, rebar positions,…
propName = 'sectionName'
class postprocess.element_section_map.ElementSections(name, directions=[1, 2], gaussPoints=[1], elemSet=None)

Bases: object

This class defines the list of reinforced concrete sections that are going to be associated to a set of elements in order to carry out the verifications of the limit states.

Variables:
  • name – name given to the list of reinforced concrete sections
  • directions – list of the directions to consider for each integration point.
  • gaussPoints – list of the integration points to consider for each element.
  • lstRCSects

    list of reinforced concrete fiber-sections that will be associated to a set of elements in order to carry out their LS verifications. The items of the list are instances of the objects derived from RCSectionBase

    The sections are ordered by integration point and then by direction. For example for an element with three integration point and two directions the order is as follows:

    lstRCSects[0]= integration point 1, direction 1 lstRCSects[1]= integration point 1, direction 2 lstRCSects[2]= integration point 2, direction 1 lstRCSects[3]= integration point 2, direction 2 lstRCSects[4]= integration point 3, direction 1 lstRCSects[5]= integration point 3, direction 2

  • elemSet – set with the elements to which to assign the section (defaults to None).
append_section(RCSimplSect)
creaSingleSection(templateSection, direction, gaussPnt)

create a copy of the section argument for the gauss points and the direction arguments.

createSections(templateSections)

create the fiber sections that represent the material to be used for the checking on each integration point and/or each direction. These sections are also added to the attribute ‘lstRCSects’ that contains the list of sections.

class postprocess.element_section_map.RCMemberSection(name, templateSections, directions=[1], gaussPoints=[1, 2], elemSet=None)

Bases: postprocess.element_section_map.ElementSections

This class is an specialization of ElemenSections for rectangular sections. The items of the list are instances of the object RCRectangularSection

createSections()

create the fiber sections that represent the reinforced concrete fiber section to be used for the checking on each integration point and/or each direction. These sections are also added to the attribute ‘lstRCSects’ that contains the list of sections.

class postprocess.element_section_map.RCSlabBeamSection(name, sectionDescr, concrType, reinfSteelType, depth, width=1.0, elemSet=None)

Bases: postprocess.element_section_map.setRCSections2SetElVerif

This class is used to define the variables that make up the two reinforced concrete sections that define the two reinforcement directions of a slab or the front and back ending sections of a beam element

Variables:
  • sectionDescr – section description
  • concrType – type of concrete (e.g. EHE_materials.HA25)
  • reinfSteelType – type of reinforcement steel
  • depth – cross-section depth
  • width – cross-section width (defaults to 1.0)
  • dir1PositvRebarRows – layers of main rebars in direction 1 in the local positive face of the section (list of ReinfRow)
  • dir1NegatvRebarRows – layers of main rebars in direction 1 in the local negative face of the section (list of ReinfRow)
  • dir2PositvRebarRows – layers of main rebars in direction 2 in the local positive face of the section (list of ReinfRow)
  • dir2NegatvRebarRows – layers of main rebars in direction 2 in the local negative face of the section (list of ReinfRow)
  • dir1ShReinfY – instance of class ShearReinforcement that represents the Y shear reinforcement in section 1
  • dir1ShReinfZ – instance of class ShearReinforcement that represents the Z shear reinforcement in section 1
  • dir2ShReinfY – instance of class ShearReinforcement that represents the Y shear reinforcement in section 2
  • dir2ShReinfZ – instance of class ShearReinforcement that represents the Z shear reinforcement in section 2
createSections()

create the fiber sections of type ‘RCRectangularSection’ that represent the reinforced concrete fiber section to be used for the checking on each integration point and/or each direction. These sections are also added to the attribute ‘lstRCSects’ that contains the list of sections.

getAs1neg()

Steel area in local negative face direction 1.

getAs1pos()

Steel area in local positive face direction 1.

getAs2neg()

Steel area in local negative face direction 2.

getAs2pos()

Steel area in local positive face direction 2.

getDiam(code)

list of bar diameter.

getDiam1neg()

list of bar diameter in rows of the local negative face direction 1.

getDiam1pos()

list of bar diameter in rows of the local positive face direction 1.

getDiam2neg()

list of bar diameter in rows of the local negative face direction 2.

getDiam2pos()

list of bar diameter in rows of the local positive face direction 2.

getMainReinfProperty(code)
getNBar1neg()

list of number of bars in rows of the local negative face direction 1.

getNBar1pos()

list of number of bars in rows of the local positive face direction 1.

getNBar2neg()

list of number of bars in rows of the local negative face direction 2.

getNBar2pos()

list of number of bars in rows of the local positive face direction 2.

getReinfArea(code)

get steel area. code=’As1+’ for direction 1, positive face code=’As1-‘ for direction 1, negative face code=’As2+’ for direction 2, positive face code=’As2-‘ for direction 2, negative face

getS(code)

list of distances between bars code=’s1+’ for direction 1, positive face code=’s1-‘ for direction 1, negative face code=’s2+’ for direction 2, positive face code=’s2-‘ for direction 2, negative face

getS1neg()

list of distances between bars of rows in the local negative face direction 1.

getS1pos()

list of distances between bars of rows the in local positive face direction 1.

getS2neg()

list of distances between bars of rows in the local negative face direction 2.

getS2pos()

list of distances between bars of rows in the local positive face direction 2.

getTemplateSection(posReb, negReb, YShReinf, ZShReinf)

Return the template section to use with createSingleSection method.

setShearReinfD1(nShReinfBranches, areaShReinfBranch, spacing)
setShearReinfD2(nShReinfBranches, areaShReinfBranch, spacing)
postprocess.element_section_map.loadMainRefPropertyIntoElements(elemSet, sectionContainer, code)

add to each element of the set the desired property (As1+,As1-,…,d1+,d1-,…).

class postprocess.element_section_map.setRCSections2SetElVerif(name, directions, gaussPoints, elemSet)

Bases: postprocess.element_section_map.ElementSections

This class is an specialization of ElemenSections for rectangular sections. The items of the list are instances of the object RCRectangularSection

getAsneg(sectNmb)

Steel area in local negative face of the simple section identified by the sectNmb

Parameters:sectNmb – integer number identifying the section (1 correponds to the section stored in lstRCSects[0] …)
getAspos(sectNmb)

Steel area in local positive face of the simple section identified by the sectNmb

Parameters:sectNmb – integer number identifying the section (1 correponds to the section stored in lstRCSects[0] …)
getDiamneg(sectNmb)

list of bar diameter in rows of the local negative face of the simple section identified by the sectNmb

Parameters:sectNmb – integer number identifying the section (1 correponds to the section stored in lstRCSects[0] …)
getDiampos(sectNmb)

list of bar diameter in rows of the local positive face of the simple section identified by the sectNmb

Parameters:sectNmb – integer number identifying the section (1 correponds to the section stored in lstRCSects[0] …)
getNBarneg(sectNmb)

list of number of bars in rows of the local negative face of the simple section identified by the sectNmb

Parameters:sectNmb – integer number identifying the section (1 correponds to the section stored in lstRCSects[0] …)
getNBarpos(sectNmb)

list of number of bars in rows of the local positive face of the simple section identified by the sectNmb

Parameters:sectNmb – integer number identifying the section (1 correponds to the section stored in lstRCSects[0] …)
getSneg(sectNmb)

list of distances between bars of rows in the local negative face of the simple section identified by the sectNmb

Parameters:sectNmb – integer number identifying the section (1 correponds to the section stored in lstRCSects[0] …)
getSpos(sectNmb)

list of distances between bars of rows the in local positive face of the simple section identified by the sectNmb

Parameters:sectNmb – integer number identifying the section (1 correponds to the section stored in lstRCSects[0] …)
setShearReinf(sectNmb, nShReinfBranches, areaShReinfBranch, spacing)

sets parameters of the shear reinforcement of the simple section identified by the sectNmb

Parameters:
  • sectNmb – integer number identifying the section (1 correponds to the section stored in lstRCSects[0] …)
  • nShReinfBranches – number of shear reinforcing branches
  • areaShReinfBranch – area of the cross-section of each stirrup
  • spacing – spacing of the stirrups

Extrapolate elemement attributes

postprocess.extrapolate_elem_attr.average_on_nodes(preprocessor, touchedNodesTags, attributeName)

Divide by number of elements in the set that touch the node.

postprocess.extrapolate_elem_attr.create_attribute_at_nodes(xcSet, attributeName, initialValue)

Create an attribute on the nodes of the set passed as parameter. return tags of the affected nodes.

Parameters:
  • xcSet – nodes that will receive the attribute.
  • attributeName – name of the attribute to define.
  • initialValue – initial value to assign to the attribute.
postprocess.extrapolate_elem_attr.extrapolate_elem_data_to_nodes(elemSet, attributeName, function, argument=None, initialValue=0.0)

Extrapolate element’s function values to the nodes.

Parameters:
  • elemSet – set of elements.
  • attributeName – name of the property which will be defined at the nodes.
  • method – name of the method to call for each element.
  • argument – name of the argument for the function call function (optional).
  • initialValue – initial value for the attribute defined at the nodes.
postprocess.extrapolate_elem_attr.extrapolate_elem_function_attr(elemSet, attributeName, function, argument, initialValue=0.0)

Extrapolate element’s function values to the nodes.

Parameters:
  • elemSet – set of elements.
  • attributeName – name of the property which will be defined at the nodes.
  • function – name of the function to call for each element.
  • argument – name of the argument for the function call function (optional).
  • initialValue – initial value for the attribute defined at the nodes.
postprocess.extrapolate_elem_attr.flatten_attribute(elemSet, attributeName, treshold, limit)

Reduce higher values which hide attribute variation over the model.

Parameters:
  • elemSet – set of elements to deal with.
  • attributeName – attribute to be flattened.
  • treshold – starting value to apply flatten.
  • limit – limit

Figure collection

class postprocess.figure_collection.FigsCollectionPlotter

Bases: object

fUnits = '[kN/m]'
fieldFilesPath = 'reinforcement/results/'
graphicOutputPath = 'post_process/results/figures/'
latexOutputPath = 'post_process/results/'
mUnits = '[kN m/m]'
plotFatigue(preprocessor, partName, elemSetName)
plotFissurationFreq(preprocessor, partName, elemSetName)
plotFissurationQP(preprocessor, partName, elemSetName)
plotNormalStresses(preprocessor, partName, elemSetName)
plotShear(preprocessor, partName, elemSetName)
reinforcementText1 = 'Longitudinal reinforcement'
reinforcementText2 = 'Transverse reinforcement'
sUnits = '[MPa]'

Get reactions

Reactions on nodes.

class postprocess.get_reactions.Reactions(preprocessor, supportNodes)

Bases: object

getReactionForces()

Returns a dictionary with the reactions forces at the nodes. The key of the map is the node tag.

getReactionMoments()

Returns a dictionary with the reactions moments at the nodes. The key of the map is the node tag.

getResultant()

Limit state data

class postprocess.limit_state_data.FatigueResistanceRCLimitStateData

Bases: postprocess.limit_state_data.LimitStateData

Reinforced concrete shear resistance limit state data.

check(reinfConcreteSections, outputCfg=<postprocess.limit_state_data.VerifOutVars object>)

Checking of fatigue under fatigue combinations loads in ultimate limit states (see self.dumpCombinations).

Parameters:
  • reinfConcreteSections – Reinforced concrete sections on each element.
  • outputCfg – instance of class ‘VerifOutVars’ which defines the variables that control the output of the checking (set of elements to be analyzed, append or not the results to a file, generation or not of lists, …)
dumpCombinations(combContainer, loadCombinations)

Load into the solver the combinations needed for this limit state.

Parameters:
  • combContainer – container with the definition of the different combination families (ULS, fatigue, SLS,…) see actions/combinations module.
  • loadCombinations – load combination handler inside the XC solver.
class postprocess.limit_state_data.FreqLoadsCrackControlRCLimitStateData

Bases: postprocess.limit_state_data.LimitStateData

Reinforced concrete crack control under frequent loads limit state data.

check(reinfConcreteSections, outputCfg=<postprocess.limit_state_data.VerifOutVars object>)
Checking of crack width under frequent loads in serviceability limit states
(see self.dumpCombinations).
Parameters:
  • reinfConcreteSections – Reinforced concrete sections on each element.
  • outputCfg – instance of class VerifOutVars which defines the variables that control the output of the checking (set of elements to be analyzed, append or not the results to file, generation or not of lists, …)
dumpCombinations(combContainer, loadCombinations)

Load into the solver the combinations needed for this limit state.

Parameters:
  • combContainer – container with the definition of the different combination families (ULS, fatigue, SLS,…) see actions/combinations module.
  • loadCombinations – load combination handler inside the XC solver.
class postprocess.limit_state_data.FreqLoadsDisplacementControlLimitStateData

Bases: postprocess.limit_state_data.LimitStateData

Displacement control under frequent loads limit state data.

check(reinfConcreteSections)

Checking of displacements under frequent loads in serviceability limit states (see self.dumpCombinations).

Parameters:reinfConcreteSections – Reinforced concrete sections on each element.
dumpCombinations(combContainer, loadCombinations)

Load into the solver the combinations needed for this limit state.

Parameters:
  • combContainer – container with the definition of the different combination families (ULS, fatigue, SLS,…) see actions/combinations module.
  • loadCombinations – load combination handler inside the XC solver.
class postprocess.limit_state_data.LimitStateData(limitStateLabel, outputDataBaseFileName)

Bases: object

createOutputFiles()

Create the internal forces and displacement output files.

envConfig = None
getDisplacementsFileName()

Return the file name to read: combination name, node number and displacements (ux,uy,uz,rotX,rotY,rotZ).

getInternalForcesFileName()

Return the file name to read: combination name, element number and internal forces.

getLastCalculationTime()

Return the time of last modification of the internal forces file.

getOutputDataBaseFileName()

Return the output file name without extension.

getOutputDataFileName()

Return the Python executable file name.

loadPickleObject(objName)

Read a Python object from a pickle file.

runChecking(outputCfg)

This method reads, for the elements in setCalc, the internal forces previously calculated and saved in the corresponding file. Using the ‘initControlVars’ and ‘checkSetFromIntForcFile’ methods of the controller, the appropiate attributes are assigned to the elements and the associated limit state verification is run. The results are written to a file in order to be displayed or listed.

Parameters:
  • outputCfg – instance of class ‘VerifOutVars’ which defines the variables that control the output of the checking (set of elements to be analyzed, append or not the results to the result file [defatults to ‘N’], generation or not of list file [defatults to ‘N’, …)
  • setCalc – set that contains elements to be checked
  • appendToResFile – ‘Yes’,’Y’,’y’,.., if results are appended to existing file of results (defaults to ‘N’)
  • listFile – ‘Yes’,’Y’,’y’,.., if latex listing file of results is desired to be generated (defaults to ‘N’)
saveAll(combContainer, setCalc, fConvIntForc=1.0, analysisToPerform=<function defaultAnalysis>, lstSteelBeams=None)

Write internal forces, displacements, .., for each combination

Parameters:
  • setCalc – set of entities for which the verification is going to be performed
  • fConvIntForc – conversion factor between the unit of force in which the calculation is performed and that one desired for the displaying of internal forces (The use of this factor won’t be allowed in future versions)
  • lstSteelBeams – list of steel beams to analyze (defaults to None)
writeDisplacements(combNm, nodSet)
Writes the resuls of displacements in a load combination
and set of nodes given as parameters
Parameters:
  • combNM – name of the load combination
  • nodSet – set of nodes
writeInternalForces(internalForcesDict)

Write the internal forces results.

class postprocess.limit_state_data.NormalStressesRCLimitStateData

Bases: postprocess.limit_state_data.LimitStateData

Reinforced concrete normal stresses data for limit state checking.

check(reinfConcreteSections, outputCfg=<postprocess.limit_state_data.VerifOutVars object>)

Checking of normal stresses in ultimate limit states (see self.dumpCombinations).

Parameters:
  • reinfConcreteSections – Reinforced concrete sections on each element.
  • outputCfg – instance of class ‘VerifOutVars’ which defines the variables that control the output of the checking (set of elements to be analyzed, append or not the results to a file, generation or not of lists, …)
dumpCombinations(combContainer, loadCombinations)

Load into the solver the combinations needed for this limit state.

Parameters:
  • combContainer – container with the definition of the different combination families (ULS, fatigue, SLS,…) see actions/combinations module.
  • loadCombinations – load combination handler inside the XC solver.
class postprocess.limit_state_data.QPLoadsCrackControlRCLimitStateData

Bases: postprocess.limit_state_data.LimitStateData

Reinforced concrete crack control under quasi-permanent loads limit state data.

check(reinfConcreteSections, outputCfg=<postprocess.limit_state_data.VerifOutVars object>)

Checking of crack width under quasi-permanent loads in serviceability limit states (see self.dumpCombinations).

Parameters:
  • reinfConcreteSections – Reinforced concrete sections on each element.
  • outputCfg – instance of class VerifOutVars which defines the variables that control the output of the checking (set of elements to be analyzed, append or not the results to file, generation or not of lists, …)
dumpCombinations(combContainer, loadCombinations)

Load into the solver the combinations needed for this limit state.

Parameters:
  • combContainer – container with the definition of the different combination families (ULS, fatigue, SLS,…) see actions/combinations module.
  • loadCombinations – load combination handler inside the XC solver.
class postprocess.limit_state_data.ShearResistanceRCLimitStateData

Bases: postprocess.limit_state_data.LimitStateData

Reinforced concrete shear resistance limit state data.

check(reinfConcreteSections, outputCfg=<postprocess.limit_state_data.VerifOutVars object>)

Checking of shear resistance in ultimate limit states (see self.dumpCombinations).

Parameters:
  • reinfConcreteSections – Reinforced concrete sections on each element.
  • outputCfg – instance of class ‘VerifOutVars’ which defines the variables that control the output of the checking (set of elements to be analyzed, append or not the results to a file, generation or not of lists, …)
dumpCombinations(combContainer, loadCombinations)

Load into the solver the combinations needed for this limit state.

Parameters:
  • combContainer – container with the definition of the different combination families (ULS, fatigue, SLS,…) see actions/combinations module.
  • loadCombinations – load combination handler inside the XC solver.
class postprocess.limit_state_data.VerifOutVars(setCalc=None, appendToResFile='N', listFile='N', calcMeanCF='N')

Bases: object

Variables that control the output of limit state verifications.

Parameters:
  • setCalc – set of elements to be analyzed (defaults to ‘None’ which means that all the elements in the file of internal forces results are analyzed)
  • appendToResFile – ‘Yes’,’Y’,’y’,.., if results are appended to existing file of results (defaults to ‘N’)
  • listFile – ‘Yes’,’Y’,’y’,.., if latex listing file of results is desired to be generated (defaults to ‘N’)
  • calcMeanCF – ‘Yes’,’Y’,’y’,.., if average capacity factor is meant to be calculated (defaults to ‘N’)
postprocess.limit_state_data.calc_max_compression_axial_forces(setCalc, intForcCombFileName, outputFileName)

Calculate maximum compression forces for the elements included in setCalc among the load combinations for which internal-force results are stored in intForcCombFileName. The maximum tension forces calculated are written to outputFileName file.

postprocess.limit_state_data.calc_max_tension_axial_forces(setCalc, intForcCombFileName, outputFileName)

Calculate maximum tension forces for the elements included in setCalc among the load combinations for which internal-force results are stored in intForcCombFileName. The maximum tension forces calculated are written to outputFileName file.

postprocess.limit_state_data.defaultAnalysis(feProb, steps=1)

Default analysis procedure for saveAll method.

postprocess.limit_state_data.oldReadIntForcesFile(intForcCombFileName, setCalc=None)

Extracts element and combination identifiers from the internal forces listing file. Return elementTags, idCombs and internal-forces values

Parameters:
  • intForcCombFileName – name of the file containing the internal forces obtained for each element for the combinations analyzed
  • setCalc – set of elements to be analyzed (defaults to None which means that all the elements in the file of internal forces results are analyzed)
postprocess.limit_state_data.readIntForcesDict(intForcCombFileName, setCalc=None)

Extracts element and combination identifiers from the internal forces listing file. Return elementTags, idCombs and internal-forces values

Parameters:
  • intForcCombFileName – name of the file containing the internal forces obtained for each element for the combinations analyzed
  • setCalc – set of elements to be analyzed (defaults to None which means that all the elements in the file of internal forces results are analyzed)
postprocess.limit_state_data.readIntForcesFile(intForcCombFileName, setCalc=None)

Extracts element and combination identifiers from the internal forces listing file. Return elementTags, idCombs and internal-forces values

Parameters:
  • intForcCombFileName – name of the file containing the internal forces obtained for each element for the combinations analyzed
  • setCalc – set of elements to be analyzed (defaults to None which means that all the elements in the file of internal forces results are analyzed)
postprocess.limit_state_data.string_el_max_axial_force(element, section, setName, combName, axialForc)

MEDMEM to XC variables

Phantom model

class postprocess.phantom_model.PhantomModel(preprocessor, sectionDistribution)

Bases: object

Model made of ZeroLengthSection elements that is used only for checking limit states i.e. for reinforced concrete sections.

This kind of phantom model is needed when the model that we use to check limit states is different from the model that we use for the analysis. A typical example:

  • The internal forces under different load combinations are obtained using a linear elastic model for the materials.
  • A “phantom model” with a more realistic representation of the cross sections (fiber models,…) is used for limit state checking at cross section level (crack control, shear,…).
build(intForcCombFileName, controller, setCalc=None)

Builds the phantom model from the data read from the file.

Parameters:
  • intForcCombFileName – name of the file containing the forces and bending moments obtained for each element for all the combinations analyzed
  • controller – object that takes the internal forces and the section definition and checks the limit state.
  • setCalc – set of elements to be analyzed (defaults to None which means that all the elements in the file of internal forces results are analyzed)
check(controller)

Runs the analysis (linear) and checking of combinations passed as parameters

Parameters:
  • elements – elements to check
  • analysis – type of analysis
  • controller – object that controls limit state in elements.
createElements(intForcCombFileName, controller, setCalc=None)

Creates the phantom model elements from the data read on the file.

Parameters:
  • intForcCombFileName – name of the file containing the internal forces obtained for each element for the combinations analyzed
  • controller – object that takes the internal forces and the section definition and checks the limit state.
  • setCalc – set of elements to be analyzed (defaults to None which means that all the elements in the file of internal forces results are analyzed)
createLoads(intForcCombFileName, controller)

Creates the loads from the data read from the file.

Parameters:
  • intForcCombFileName – name of the file containing the forces and bending moments obtained for each element for all the combinations analyzed
  • controller – object that takes the internal forces and the section definition and checks the limit state.
createPhantomElement(idElem, sectionName, sectionDefinition, sectionIndex, interactionDiagram, fakeSection)

Creates a phantom element (that represents a section to check)

Parameters:
  • idElem – identifier of the element in the “true” model associated with the phantom element to be created.
  • sectionName – name of the 3D fiber section to create the zero-length phantom element (default material)
  • idSection – name of the section assigned to the phantom element (the section to check) -sectionName-.
  • sectionIndex – index of the section in the “true” model element -sectionIndex-. To be renamed as sectionIndex.
  • interactionDiagram – interaction diagram that corresponds to the section to check.
  • fakeSection – if True (default value) generates a fake section of type ‘xc.ElasticShearSection3d’, if False, generates a true fiber model of the section (xc.FiberSectionShear3d)
runChecking(limitStateData, outputCfg)

Run the analysis, check the results and write them into a file

Parameters:
  • limitStateData – object that contains the name of the file containing the internal forces obtained for each element for the combinations analyzed and the controller to use for the checking.
  • outputCfg – instance of class ‘VerifOutVars’ which defines the variables that control the output of the checking (set of elements to be analyzed, append or not the results to a file, generation or not of lists, …)
setupForElementsAndCombinations(intForcCombFileName, setCalc=None)
Extracts element and combination identifiers from the internal
forces listing file.
Parameters:
  • intForcCombFileName – name of the file containing the internal forces obtained for each element for the combinations analyzed
  • setCalc – set of elements to be analyzed (defaults to None which means that all the elements in the file of internal forces results are analyzed)
write(controller, outputFileName, outputCfg)

Writes results into the output file

Parameters:
  • controller – object that controls limit state in elements
  • outputFileName – base name of output file (extensions .py and .tex)
  • outputCfg – instance of class ‘VerifOutVars’ which defines the variables that control the output of the checking (append or not the results to a file, generation or not of lists, …)

Statistics propeties

postprocess.prop_statistics.getItemWithMaxProp(iterable, attrName, argv='')

Return item wich maximizes property named as indicated in attrName

postprocess.prop_statistics.getItemWithMinProp(iterable, attrName)

Return item wich minimizes property named as indicated in attrName

postprocess.prop_statistics.rec_getattr(obj, attr, argv='')

Get object’s attribute. May use dot notation.

>>> class C(object): pass
>>> a = C()
>>> a.b = C()
>>> a.b.c = 4
>>> rec_getattr(a, 'b.c')
4
postprocess.prop_statistics.rec_setattr(obj, attr, value)

Set object’s attribute. May use dot notation.

>>> class C(object): pass
>>> a = C()
>>> a.b = C()
>>> a.b.c = 4
>>> rec_setattr(a, 'b.c', 2)
>>> a.b.c
2

RC material distribution

class postprocess.RC_material_distribution.RCMaterialDistribution

Bases: object

Spatial distribution of reinforced concrete material (RC sections distribution over the elements). It refers to the reinforced concrete sections associated with the element (i.e. for shell elements we typically define two RC sections, one for each main direction; in the case of beam elements the most common way is to define RC sections in the front and back ends of the elements)

assign(elemSet, setRCSects)

Assigns the sections names: setRCSectsName+‘1’, setRCSectsName+‘2’, … to the elements of the set.

Parameters:
  • elemSet – set of elements that receive the section name property.
  • setRCSects – RC section definition, name, concrete type, rebar positions,…
dump()

Writes this object in a pickle file.

getElementSet(preprocessor)

Returns an XC set that contains all the elements with an assigned section.

getSectionDefinition(sectionName)

Returns the section definition which has the name being passed as a parameter.

getSectionDefinitionsForElement(tagElem)

Returns the section names for the element which tag is being passed as a parameter.

getSectionNamesForElement(tagElem)

Returns the section names for the element which tag is being passed as a parameter.

internalForcesVerification2D(limitStateData, matDiagType, setCalc=None)

Limit state verification based on internal force (Fx,Fy,Mz) values.

Parameters:
  • limitStateData – object that contains the name of the file containing the internal forces obtained for each element for the combinations analyzed and the controller to use for the checking.
  • matDiagType – type of the material diagram (d: design, k: characteristic).
  • setCalc – set of elements to be analyzed (defaults to None which means that all the elements in the file of internal forces results are analyzed)
internalForcesVerification3D(limitStateData, matDiagType, outputCfg)

Limit state verification based on internal force (Fx,Fy,Fz,Mx,My,Mz) values.

Parameters:
  • limitStateData – object that contains the name of the file containing the internal forces obtained for each element for the combinations analyzed and the controller to use for the checking.
  • matDiagType – type of the material diagram (d: design, k: characteristic).
  • outputCfg – instance of class ‘VerifOutVars’ which defines the variables that control the output of the checking (set of elements to be analyzed, append or not the results to a file, generation or not of lists, …)
load()

Reads this object from a pickle file.

mapSectionsFileName = './mapSectionsReinforcement.pkl'
runChecking(limitStateData, matDiagType, threeDim=True, outputCfg=<postprocess.limit_state_data.VerifOutVars object>)

Creates the phantom model and runs the verification on it.

Parameters:
  • limitStateData – object that contains the name of the file containing the internal forces obtained for each element for the combinations analyzed and the controller to use for the checking.
  • matDiagType – type of the material diagram (d: design, k: characteristic).
  • threeDim – true if it’s 3D (Fx,Fy,Fz,Mx,My,Mz) false if it’s 2D (Fx,Fy,Mz).
  • outputCfg – instance of class ‘VerifOutVars’ which defines the variables that control the output of the checking (set of elements to be analyzed, append or not the results to a file, generation or not of lists, …)
postprocess.RC_material_distribution.loadRCMaterialDistribution()

Load the reinforced concrete sections on each element from file.

Recorders

postprocess.recorders.installNodeDisplacementRecorder(recorderName, nodeSet)

Utils display

class postprocess.utils_display.FigureBase(pLabel, limitStateLabel, figDescr, reinfDescr=None, units=None, sz='90mm')

Bases: object

getCaption()
getFileName()
insertIntoLatex(fichLatexFigs, fichLatexList, fichFig, labelText)
Parameters:
  • fichLatexFigs – latex file to insert graphic into
  • fichFig – name of the file that contains the graphic (complete path without extension).
class postprocess.utils_display.FigureDefinition(pLabel, limitStateLabel, attrName, argument, figDescr, reinfDescr=None, units=None, sz='90mm')

Bases: postprocess.utils_display.SlideDefinition

defField(xcSet)
diagrams = None
genGraphicFile(displaySettings, xcSet, nmbFichGraf)
class postprocess.utils_display.PartToDisplay(partName, surfaceList, reinforcementLabels)

Bases: object

display(preprocessor, tp, resultsToDisplay)

Generate an image for every result to display

Parameters:resultToDisplay – collection of results to be displayed.
getElementSet(preprocessor)
getElements()

Returns a list of the elements of this part.

getShortName()
class postprocess.utils_display.PartToDisplayContainer(lst)

Bases: dict

Parts to display in figures…

add(part)
display(preprocessor, tp, resultsToDisplay)

Display results for each part.

Parameters:resultToDisplay – collection of results to be displayed.
class postprocess.utils_display.SlideDefinition(pLabel, limitStateLabel, figDescr, reinfDescr=None, units=None, sz='90mm')

Bases: postprocess.utils_display.FigureBase

genGraphicFile(preprocessor, displaySettings, xcSet, nmbFichGraf)
setupDiagrams()
class postprocess.utils_display.TakePhotos(xcSet)

Bases: object

Generation of bitmaps with analysis and design results.

displayFigures(figDefinitionList, LatexFigsFilename, LatexListFilename)

Creates graphics files from figure definition list.

Parameters:
  • nmbLstIss – name of the lists that contains the results to display.
  • LatexFilename – name of the LaTeX file to write the graphics on.
insertFigureLatex(figDef, conta, fichFig, labelText)
Parameters:
  • fichLatexFigs – latex file to insert graphic into
  • fichFig – name of the file that contains the graphic (complete path without extension).
plotFigures(preprocessor, figDefinitionList, LatexFigsFilename, LatexListFilename)
postprocess.utils_display.plotStressStrainFibSet(fiberSet, title, fileName=None, nContours=100, pointSize=50, fiberShape='o')

Represents graphically the cross-section current stresses and strains. The graphics are generated by a triangulation from the x,y coordinates of the fibers.

Parameters:
  • fiberSet – set of fibers to be represented
  • title – general title for the graphic
  • fileName – name of the graphic file (defaults to None: no file generated)
  • nContours – number of contours to be generated (defaults to 100). If nContours=0 or nContours=None, then each fiber is represented by a makred.
  • pointSize – size of the circles to represent each of the fibers in the set in the case that nContours=0 or nContours=None (defaults to 50)
  • fiberShape – marker to represent each fiber, in case nContours = 0 or None.e.g.: “o”->circle, “s”->square, “p”->pentagon (defaults to circle)
class postprocess.utils_display.setToDisplay(elSet, genDescr='', sectDescr=[])

Bases: object

Defines the description of a set of elements to be used in the graphics and reports associated with the calculation

Variables:
  • elSet – set of elements
  • genDescr – general description
  • sectDescr – ordered list with the descriptions that apply to each of the sections that configures the element.