Table of Contents

activate
Activates features.
add
Adds a section to a polycurve or a row to an advanced table.
adddesignapproachmateriallink
Adds design approach material factor to a material parameter.
addedmass
Adds Westergaard AddedMass feature features to lines.
addpoint
Adds a new point to a polygon or water level.
addsubcurve
Adds a sub section to a tunnel cross section.
addwaterpoint
Adds a water point to a water level.
__allocmem
Tests if it is possible to allocate a specific amount of additional memory.
anchormat
Creates a anchor material set.
apply
Applies a command to multiple objects at once.
arrayp
Creates an array from one or more objects.
arrayr
Creates an array from one or more objects.
borehole
Adds a new borehole.
calculate
Calculates all phases that are currently marked for calculation.
checkcalculationconditions
Performs the pre-calculation checks on conditions and settings of the defined phases.
checkgeometry
Checks geometry consistency with a default tolerance value of (0.005 * diagonal of the model) or with an optional tolerance parameter. Checks if objects overlap or are adjacent and then returns the objects with the distance between them.
__clear
Deletes all objects.
clearmaterial
Clears the assignment of the Material property of any Soil or Structure object in any mode.
close
Closes a polycurve.
coarsen
Requests a coarser mesh for a meshable object.
commands
Displays available commands and their signatures.
connection
Creates a connection between two objects: the custom part and the reference part.
contraction
Adds contraction features to lines.
copylayers
Copies the soil layer properties from one borehole to other boreholes.
count
Displays the number of objects of a specified type that are present.
createreachedwl
Creates a new water level at the position reached at the end of the previous phase. The location of the water level will be constant in the current phase.
createreachedwlandcontinue
Creates a new water level at the position reached at the end of the previous phase. The location of the water level in the current phase will change from that point on according to the flow function assigned to the original water level in the previous phase.
cutpoly
Cuts/divides polygons.
deactivate
Deactivates features.
delete
Deletes objects.
deletepoint
Deletes a point of a polygon or water level.
__delruntimetoggle
Removes a runtime toggle.
designapproach
Adds design approach.
dischargefunction
Adds a discharge function.
displmultiplier
Adds a displacement multiplier.
drain
Adds drain features to lines.
__dump
Displays the details of the project.
__dumpboreholes
Displays a list of all boreholes.
__dumpcutobjects
Displays a list of all cut objects.
__dumpfixedendanchors
Displays a list of all fixed-end anchors.
__dumpgeogrids
Displays a list of all geogrids.
__dumpgroups
Displays a list of all groups.
__dumplinedispls
Displays a list of all line prescribed displacements.
__dumplineloads
Displays a list of all line loads.
__dumplines
Displays a list of all lines.
__dumpmaterials
Displays a list of all materials.
__dumpmeshes
Displays the details of the mesh of a cut object.
__dumpn2nanchors
Displays a list of all node-to-node anchors.
__dumpnegativeinterfaces
Displays a list of all negative interfaces.
__dumpphases
Displays a list of all phases.
__dumppiles
Displays a list of all embedded piles.
__dumpplates
Displays a list of all plates.
__dumppointdispls
Displays a list of all point prescribed displacements.
__dumppointloads
Displays a list of all point loads.
__dumppoints
Displays a list of all points.
__dumppositiveinterfaces
Displays a list of all positive interfaces.
__dumppolygons
Displays a list of all polygons.
__dumpsoillayers
Displays a list of all soil layers.
duplicate
Duplicates water levels.
embeddedbeamrow
Adds embedded beam row features to lines.
embeddedbeammat
Creates an embedded beam material set.
embeddedpilerow
Adds embedded pile row features to lines.
embeddedpilemat
Creates an embedded pile material set.
echo
Displays the details of an object.
__echotunnelvalidation
Displays the errors, warnings and tips related to cross-section, properties, trajectory and sequencing of a tunnel in the tunnel designer.
export
Exports 2D models, structural entities, geometries, cutobjects, as CAD file formats (.step, .stp, .dxf, .brep)
extendtosymmetryaxis
Extends a polycurve to its symmetry axis by adding a new segment.
fieldstress
Assigns the field stress feature to a soil or rock cluster.
findcutobject
Finds the source entities of the specified cutobject or list of cutobjects in staged construction.
filter
Displays a list of specified objects.
findstagedfeature
Finds a feature in the staged construction mode.
fixedendanchor
Adds fixed-end anchor features to points.
generateintersectionpoints
Generates intersection points between two entities.
generatefromfielddata
Generates the soil stratigraphy of a borehole based on assigned field data.
generatetunnel
Generates the geometry representing the tunnel description.
generatethicklining
Generates a thick lining for a tunnel.
geogrid
Adds geogrid features to lines.
geogridmat
Creates a geogrid material set.
reinforcement
Adds rockbolts to a polycurve chain.
__getcurveresults
Displays the calculated values of a particular block of the specified phase.
__getnormal
Displays the normal of a polygon.
__getresults
Displays calculation results.
getsoillayerlevel
Returns the location of a soil layer boundary at a borehole.
getsoillayerporepressure
Returns the pore pressures of a soil layer.
__gettoggle
Returns true or false depending on whether the toggle is set to true or false. If a toggle is absent, it returns false.
__gogreen
Instructs the computer to logoff/sleep/hibernate/poweroff.
gotomesh
Switches to Mesh mode.
gotosoil
Switches to Soil mode.
gotostages
Switches to Staged construction mode.
gotostructures
Switches to Structures mode.
gotoflow
Switches to flow conditions mode.
gotowater
Switches to flow conditions mode.
gwfbc
Adds groundwater flow boundary condition features to lines.
group
Groups one or more objects.
groupfiltered
Makes a group of one or more objects that fulfill a certain criterion.
headfunction
Adds a head function.
heatfluxfunction
Adds a heat flux function.
heattotalfluxfunction
Adds a heat flux function.
help
Displays a short help for the command line functionality.
import
Imports one or more points, lines, waterlevels or polygons. The following file formats are supported: dxf, step, stp, brep. In case of a dxf import, it is important to set 'INSUNIT' global variable in the dxf file to the desired unit.
importfielddata
Imports field data.
importcrosssection
Imports one or more polycurves into the cross-section of a tunnel. If the cross-section of the tunnel is not empty, the imported segments are added to the end of the segment list. If the file contains more than one polycurve, the one with the largest bounding box is imported as the cross-section and the others as sub-sections. The imported polycurves can only contain line and arc segments, and they should be positioned on the XY-plane.
info
Displays all commands for an object.
initializerectangular
Changes the coordinates of the rectangular soil contour.
insert
Inserts a section into a polycurve.
insertsubcurve
Inserts a sub section to a tunnel cross section.
insertphase
Creates a new phase and inserts it before an existing phase.
insertpoint
Inserts a new point to an existing polygon or water level.
insertwaterpoint
Inserts a new point to an existing water level.
intersectsegments
Insertsects sub sections of a tunnel cross section.
insertsoillayer
Creates a new soil layer above an existing soil layer.
invertdirection
Inverts the direction of a line.
__kill
Closes down PLAXIS 2D Input without saving.
line
Creates a line.
lineangles
Creates lines in directions specified using an angle.
linedispl
Adds line prescribed displacement features to lines.
lineload
Adds line load features to lines.
lineparallel
Creates a line parallel to another line.
linerelative
Creates lines using relative coordinates.
linevector
Creates lines in directions specified using vectors.
loadfactorlabel
Adds a load factor label for design approaches.
loadmultiplier
Adds a load multiplier.
materialcommand
Generates the PLAXIS command to define equivalent soil material and properties in PLAXIS 2D and 3D projects.
materialfactorlabel
Adds a material factor label for design approaches.
mergeequivalents
Merges objects with a default tolerance value of 0.001 or with an optional tolerance parameter. This command removes existing objects and creates new features. The specified objects are used as initial merge set. It is possible that the merge operation will also affect objects that are directly or indirectly connected to the initial merge set (e.g. the lines connected to explicitly specified points will implicitly be taken into account during the merge operation).
mesh
Generates a mesh.
meshd
Generates a mesh based on element dimension specified in length units rather than as a factor.
move
Moves an object.
movedisconnected
Moves an object.
movepoint
Moves a point of a polygon or water level.
movepointmagnetic
Moves a polygon point and the connected objects in a specified direction.
multiply
Multiplies properties of objects with a specified factor.
n2nanchor
Adds node-to-node anchor features to lines.
neginterface
Adds negative interface features to lines.
__observers
Displays internal information about observers connected to an object, for debugging purposes.
phase
Creates a new phase.
plate
Adds plate features to lines.
platemat
Creates a plate material set.
point
Creates a point.
pointdispl
Adds point prescribed displacement features to points.
pointload
Adds point load features to points.
polycurve
Creates a polycurve.
polygon
Creates a polygon.
posinterface
Adds positive interface features to lines.
__predict
Predicts whether a command will succeed or fail.
preview
Views the mesh in a specified phase.
__raise
Generates an error in order to test the error catching functionality.
__raiseasync
Generates an error in an asynchronous thread in order to test the error catching functionality.
__raisethreaded
Generates an error in a synchronous thread in order to test the error catching functionality.
rectangle
Creates rectangle.
redo
Redo actions to which undo was applied.
refine
Requests a finer mesh for a meshable object.
regenerate
Regenerates the phase settings in one or more phases.
__removeintermediatesteps
Removes saved intermediate calculation steps.
rename
Renames an object.
__reportmem
Reports memory usage
reset
Clears the contents of a polycurve with the option to add one or more new sections.
resetlocal
Requests a reset of the fineness of a mesh.
retrievesuggestedparameters
Retrieves suggested parameters for a phase.
rockboltsperpendicular
Adds rock bolts which are perpendicular to a tunnel cross section.
save
Saves the project.
selectmeshpoints
Allows you to select points-of-interest in the mesh.
set
Changes the properties of an object in the project.
setcolour
Changes the colour of a material.
setcurrentphase
Makes a phase the current phase.
setdefaultmaterial
Forces an interface to use the material of the soil it is adjacent to.
setglobalwaterlevel
Changes the global water level.
setmaterial
Assigns a material to features.
__setphysicalcpucount
Displays or sets the amount of physical and logical CPUs.
setproperties
Changes properties of objects.
setsoillayerlevel
Sets the borehole soil layer level.
setsoillayerporepressure
Changes the pore pressures of a soil layer.
__settoggle
Sets a runtime toggle to true or false. This overrides any toggles that have already been specified.
__setundostacksize
Displays the amount of actions that can be undone and redone and the maximum revert stack size.
setwaterdry
Sets the pore pressure of one or more soil features to zero.
setwaterinterpolate
Sets that the pore pressure of one or more soil features should be interpolated.
setwaterlevel
Assigns a water level to one or more objects.
__sleep
Sets the number of milliseconds for computer to do nothing.
snap
Snaps objects with a default tolerance value of 0.001 or with an optional tolerance parameter. This command does not remove existing objects, nor creates new geometry but only adjusts the object position. The arguments are commutative, which implies that they are taken in alphabetical order for snapping despite the order of input.
snaplinear
Snaps one or more points that are connected to a line to the object given as argument, in such a way that the orientation of the connected line does not change. This command does not remove existing objects, nor creates new geometry but only adjusts the object position.
soilmat
Creates a soil material set.
soillayer
Adds a soil layer.
soillayerheight
Changes the height of a soil layer.
symmetricclose
Closes a polycurve symmetrically.
tabulate
Displays a table of properties for specified objects.
temperaturefunction
Adds a temperature function.
__testasync
Tests that asynchronous task execution works correctly.
tfbc
Adds thermal flow boundary condition features to lines.
tracepoly
Creates a polygon from two input points and from points along the contour of the existing boundary.
transferfunction
Adds a transfer function.
transform
Multiplies a multiplier by the scaling factor and writes these values into a new column of transformed multiplier. The default scaling factor is 1.0 and it can be modified in DisplacementMultiplier object.
translateline
Moves a line of an existing polygon.
translatelinemagnetic
Moves a line of an existing polygon and the connected polygon(s) in a specified direction.
tunnel
Creates a tunnel at a specified location.
undo
Reverses actions.
ungroup
Ungroups a group of objects.
view
Displays the calculation results of a phase.
viewmesh
Displays the generated mesh.
waterlevel
Creates a new water level with one or more points at a specified location.
well
Adds well features to lines.
__writephasestomesh
Writes water and load conditions to files.