Class: QgsMeshMultiLevelsAveragingMethod

class qgis.core.QgsMeshMultiLevelsAveragingMethod

Bases: QgsMesh3dAveragingMethod

Constructs single level averaging method for 1st (top) vertical level

QgsMeshMultiLevelsAveragingMethod(startLevel: int, endLevel: int, countedFromTop: bool) Constructs multi level averaging method

Parameters
  • startLevel – starting vertical level index numbered from 1

  • endLevel – ending vertical level index numbered from 1 (higher or equal than startLevel)

  • countedFromTop – if True, the startLevel index is counted from surface (index 1 is the top layer). if False, the startLevel index is counted from the bed level (index 1 is the bottom layer)

QgsMeshMultiLevelsAveragingMethod(verticalLevel: int, countedFromTop: bool) Constructs single level averaging method

Parameters
  • verticalLevel – vertical level index numbered from 1

  • countedFromTop – if True, the startLevel index is counted from surface (index 1 is the top layer). if False, the startLevel index is counted from the bed level (index 1 is the bottom layer)

QgsMeshMultiLevelsAveragingMethod(QgsMeshMultiLevelsAveragingMethod)

Multi level averaging method specifies limits of vertical layers from the top layer down or reversed.

The limits will be truncated to the maximum number of vertical layers. To pick value from a single layer, specify the upper and lower limit to be the same

Methods

clone

rtype

QgsMesh3dAveragingMethod

countedFromTop

Returns whether the start and end vertical levels are indexed from top (surface) or bottom (bed) level

endVerticalLevel

Returns ending vertical level.

equals

param other

isSingleLevel

Returns whether the averaging method selects only a single vertical level

readXml

param elem

startVerticalLevel

Returns starting vertical level.

writeXml

param doc

clone(self)QgsMesh3dAveragingMethod
Return type

QgsMesh3dAveragingMethod

countedFromTop(self) → bool

Returns whether the start and end vertical levels are indexed from top (surface) or bottom (bed) level

Return type

bool

endVerticalLevel(self) → int

Returns ending vertical level.

Numbered from 1. If countedFromTop(), 1 represents the top (surface) level, otherwise 1 represents the bottom (bed) level

Always lower or equal than endVerticalLevel()

Return type

int

equals(self, other: QgsMesh3dAveragingMethod) → bool
Parameters

other (QgsMesh3dAveragingMethod) –

Return type

bool

isSingleLevel(self) → bool

Returns whether the averaging method selects only a single vertical level

Return type

bool

readXml(self, elem: QDomElement)
Parameters

elem (QDomElement) –

startVerticalLevel(self) → int

Returns starting vertical level.

Numbered from 1. If countedFromTop(), 1 represents the top (surface) level, otherwise 1 represents the bottom (bed) level

Always lower or equal than endVerticalLevel()

Return type

int

writeXml(self, doc: QDomDocument) → QDomElement
Parameters

doc (QDomDocument) –

Return type

QDomElement