9.36 PorePressureBC object

The PorePressureBC object stores the data for a pore pressure boundary condition.

The PorePressureBC object is derived from the BoundaryCondition object.

Access
import load
mdb.models[name].boundaryConditions[name]


9.36.1 PorePressureBC(...)

This method creates a PorePressureBC object.

Path
mdb.models[name].PorePressureBC

Required arguments

name

A String specifying the boundary condition repository key.

createStepName

A String specifying the name of the step in which the boundary condition is created.

region

A Region object specifying the region to which the boundary condition is applied.

Optional arguments

fieldName

A String specifying the name of the AnalyticalField object associated with this boundary condition. The fieldName argument applies only when distributionType=FIELD. The default value is an empty string.

magnitude

A Float specifying the pore pressure magnitude. The default value is 0. The magnitude argument is optional if distributionType=USER_DEFINED.

distributionType

A SymbolicConstant specifying how the boundary condition is distributed spatially. Possible values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.

amplitude

A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the boundary condition has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

fixed

A Boolean specifying whether the boundary condition should remain fixed at the current values at the start of the step. The default value is OFF.

Return value

A PorePressureBC object.

Exceptions

None.


9.36.2 setValues(...)

This method modifies the data for an existing PorePressureBC object in the step where it is created.

Required arguments

None.

Optional arguments

The optional arguments to setValues are the same as the arguments to the PorePressureBC method, except for the name and createStepName arguments.

Return value

None

Exceptions

None.


9.36.3 setValuesInStep(...)

This method modifies the propagating data for an existing PorePressureBC object in the specified step.

Required argument

stepName

A String specifying the name of the step in which the boundary condition is modified.

Optional arguments

magnitude

A Float or the SymbolicConstant FREED specifying the pore pressure magnitude.

amplitude

A String or a SymbolicConstant specifying the name of the amplitude reference. Possible values for the SymbolicConstant are UNCHANGED and FREED. UNCHANGED should be used if the amplitude is propagated from the previous analysis step. FREED should be used if the boundary condition is changed to have no amplitude reference. You should provide the amplitude argument only if it is valid for the specified step.

Return value

None

Exceptions

None.


9.36.4  Members

The PorePressureBC object can have the following members:

name

A String specifying the boundary condition repository key.

distributionType

A SymbolicConstant specifying how the boundary condition is distributed spatially. Possible values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.

fieldName

A String specifying the name of the AnalyticalField object associated with this boundary condition. The fieldName argument applies only when distributionType=FIELD. The default value is an empty string.

category

A SymbolicConstant specifying the category of the boundary condition. Possible values are MECHANICAL and THERMAL.

region

A Region object specifying the region to which the boundary condition is applied.

localCsys

None or a DatumCsys object specifying the local coordinate system of the boundary condition's degrees of freedom. If localCsys=None, the degrees of freedom are defined in the global coordinate system. The default value is None.