geometry paint-extra command

Syntax

geometry paint-extra i keyword ... <range>

Primary keywords:

acceleration    acceleration-x    acceleration-y    acceleration-z    condition    convergence    density    density-fluid    displacement    displacement-x    displacement-y    displacement-z    extra    fluid-bulk-modulus    fluid-biot-modulus    multiplier    pore-pressure    property    property-fluid    property-thermal    ratio-local    ratio-target    saturation    set    strain-increment    strain-increment-xx    strain-increment-xy    strain-increment-xz    strain-increment-yy    strain-increment-yz    strain-increment-zz    strain-rate    strain-rate-xx    strain-rate-xy    strain-rate-xz    strain-rate-yy    strain-rate-yz    strain-rate-zz    stress    stress-xx    stress-xy    stress-xz    stress-yy    stress-yz    stress-zz    stress-effective    stress-effective-xx    stress-effective-xy    stress-effective-xz    stress-effective-yy    stress-effective-yz    stress-effective-zz    strength-stress-ratio    stress-effective    temperature    timestep-dynamic    unbalanced-force    unbalanced-force-x    unbalanced-force-y    unbalanced-force-z    velocity    velocity-x    velocity-y    velocity-z

Note

This command is only available in FLAC3D and 3DEC.

“Paint” a scalar value from a zone field. The value is painted onto nodes in the current geometric set. The values are placed in the extra variable index i on each node. The range selects which nodes of the geometric set are painted.

If the value is gridpoint-based, then a value at the node location is calculated using a weighting function inside the zone.

If the value is zone-based, the value will be determined by a curve-fitting algorithm extrapolated to the node location. Which algorithm is used can be specified in the following [zonefieldoptions]. By default a value is considered constant within a zone.

Note that if the need for “painting” is temporary (i.e., for visualization), this can be done on a geometry plot item when plotting — which bypasses the command and the overhead it requires to store the field values at gridpoints. If the set keyword is not given, then the current set is used. CS: this should have a link to a topic that describes how to do that

acceleration [zonefieldoptions]

Paint acceleration magnitude at the gridpoint (only available if model configure dynamic has been specified).

acceleration-x [zonefieldoptions]

Paint \(x\)-acceleration at the gridpoint (only available if model configure dynamic has been specified).

acceleration-y [zonefieldoptions]

Paint \(y\)-acceleration at the gridpoint (only available if model configure dynamic has been specified).

acceleration-z [zonefieldoptions]

Paint \(z\)-acceleration at the gridpoint (only available if model configure dynamic has been specified).

condition [zonefieldoptions]

Paint a measure of how badly deformed a zone is. [URGENT: CS: content required for link here appears to need adding to doc set: Link to wherever the contents of section 1.1.5 in the Command Reference end up

convergence [zonefieldoptions]

Paint the zone convergence.

density [zonefieldoptions]

Paint the density of the zone.

density-fluid [zonefieldoptions]

Paint the fluid density.

displacement [zonefieldoptions]

Paint displacement magnitude at the gridpoint.

displacement-x [zonefieldoptions]

Paint \(x\)-displacement at the gridpoint.

displacement-y [zonefieldoptions]

Paint \(y\)-displacement at the gridpoint.

displacement-z [zonefieldoptions]

Paint \(z\)-displacement at the gridpoint.

extra [zonefieldoptions]

Paint an extra variable value. The extra variable index used will default to 1 and can be changed with the index modifier keyword. The value will by default come from the zone extra variables, but this can be specified using the source modifier keyword. The value will by default be treated as a scalar floating point type, but this can be specified using the type modifier keyword.

factor-of-safety [zonehistoryblock]

The largest factor of safety that remains stable for this grid point. Only available after a model factor-of-safety calculation. The velocity-limit keyword is used to specify a velocity magnitude over which the grid point is considered unstable at a given factor of safety.

fluid-bulk-modulus [zonefieldoptions]

Paint zones by the fluid bulk modulus.

fluid-biot-modulus [zonefieldoptions]

Paint zones by the fluid Biot modulus.

multiplier [zonefieldoptions]

Pain the zone multiplier.

pore-pressure [zonefieldoptions]

Paint pore pressure in a zone. By default this will be the average zone pore pressure, but the gridpoint pressure can be specified by using the source keyword modifier.

property [zonefieldoptions]

Paint a property of the mechanical constitutive model of the zone. The property name must be specified using the name keyword modifier. By default it will be assumed the property is a floating point scalar, but this can be specified using the type modifier keyword.

property-fluid [zonefieldoptions]

Paint a property of the fluid constitutive model of the zone. The property name must be specified using the name keyword modifier. By default it will be assumed the property is a floating point scalar, but this can be specified using the type modifier keyword.

property-thermal [zonefieldoptions]

Paint a property of the thermal constitutive model of the zone. The property name must be specified using the name keyword modifier. By default it will be assumed the property is a floating point scalar, but this can be specified using the type modifier keyword.

ratio-local [zonefieldoptions]

Paint the local unbalanced force ratio at each gridpoint. Like all results, this can be changed to the logarithm of the value by using the :lkwd:’log’ keyword modifier.

ratio-target [zonefieldoptions]

Paint the target unbalanced force ratio at each gridpoint. Like all results, this can be changed to the logarithm of the value by using the :lkwd:’log’ keyword modifier.

saturation [zonefieldoptions]

Paint the saturation at the gridpoint (only available if model configure fluid has been specified).

set s

Specify the geometry set.

strain-increment [zonefieldoptions]

Paint the strain increment tensor of the zone, determined by the current displacement field. Use the quantity keyword to specify which scalar value to retrieve from the tensor.

strain-increment-xx [zonefieldoptions]

Paint the xx strain increment.

strain-increment-xy [zonefieldoptions]

Paint the xy strain increment.

strain-increment-xz [zonefieldoptions]

Paint the xz strain increment.

strain-increment-yy [zonefieldoptions]

Paint the yy strain increment.

strain-increment-yz [zonefieldoptions]

Paint the yz strain increment.

strain-increment-zz [zonefieldoptions]

Paint the zz strain increment.

strain-rate [zonefieldoptions]

Paint the strain rate tensor of the zone, determined by the current velocity field. Use the quantity keyword to specify which scalar value to retrieve from the tensor.

strain-rate-xx [zonefieldoptions]

Paint the xx strain rate.

strain-rate-xy [zonefieldoptions]

Paint the xy strain rate.

strain-rate-xz [zonefieldoptions]

Paint the xz strain rate.

strain-rate-yy [zonefieldoptions]

Paint the yy strain rate.

strain-rate-yz [zonefieldoptions]

Paint the yz strain rate.

strain-rate-zz [zonefieldoptions]

Paint the zz strain rate.

stress [zonefieldoptions]

Paint the stress tensor of the zone, determined by the weighted average of the subzone stresses. Use the quantity keyword to specify which scalar value to retrieve from the tensor.

stress-xx [zonefieldoptions]

Paint the stress-xx of the zone, determined by the weighted average of the subzone stresses.

stress-xy [zonefieldoptions]

Paint the stress-xy of the zone, determined by the weighted average of the subzone stresses.

stress-xz [zonefieldoptions]

Paint the stress-xz of the zone, determined by the weighted average of the subzone stresses.

stress-yy [zonefieldoptions]

Paint the stress-yy of the zone, determined by the weighted average of the subzone stresses.

stress-yz [zonefieldoptions]

Paint the stress-yz of the zone, determined by the weighted average of the subzone stresses.

stress-zz [zonefieldoptions]

Paint the stress-zz of the zone, determined by the weighted average of the subzone stresses.

stress-effective [zonefieldoptions]

Paint the effective stress tensor of the zone, determined by the weighted average of the subzone effective stresses. Use the quantity keyword to specify which scalar value to retrieve from the tensor.

stress-effective-xx [zonefieldoptions]

Paint the effective stress-xx of the zone, determined by the weighted average of the subzone stresses.

stress-effective-xy [zonefieldoptions]

Paint the effective stress-xy of the zone, determined by the weighted average of the subzone stresses.

stress-effective-xz [zonefieldoptions]

Paint the effective stress-xz of the zone, determined by the weighted average of the subzone effective stresses.

stress-effective-yy [zonefieldoptions]

Paint the effective stress-yy of the zone, determined by the weighted average of the subzone effective stresses.

stress-effective-yz [zonefieldoptions]

Paint the effective stress-yz of the zone, determined by the weighted average of the subzone effective stresses.

stress-effective-zz [zonefieldoptions]

Paint the effective stress-zz of the zone, determined by the weighted average of the subzone effective stresses.

strength-stress-ratio [zonefieldoptions]

Paint the ratio of the current stress to a failure surface of the zone, as determined by the current zone constitutive model. Not all constitutive models support this calculation. If unsupported, the value returned will be 10. The value returned is generally held to a maximum of 10.

stress-effective [zonefieldoptions]

Paint the effective stress tensor of the zone, determined by the weighted average of the subzone stresses minus the zone averaged pore pressure. Use the quantity keyword to specify which scalar value to retrieve from the tensor.

temperature [zonefieldoptions]

Paint the temperature at the gridpoints. The source modifier keyword can be used to specify that zone based temperature should be used instead.

timestep-dynamic [zonefieldoptions]

Paint the local critical dynamic time step of that particular gridpoint. (only available if model configure dynamic has been specified).

unbalanced-force [zonefieldoptions]

Paint the unbalanced force magnitude at the gridpoint.

unbalanced-force-x [zonefieldoptions]

Paint the \(x\)-unbalanced force at the gridpoint.

unbalanced-force-y [zonefieldoptions]

Paint the \(y\)-unbalanced force at the gridpoint.

unbalanced-force-z [zonefieldoptions]

Paint the \(z\)-unbalanced force at the gridpoint.

velocity [zonefieldoptions]

Paint the velocity magnitude at the gridpoint.

velocity-x [zonefieldoptions]

Paint the \(x\)-velocity at the gridpoint.

velocity-y [zonefieldoptions]

Paint the \(y\)-velocity at the gridpoint.

velocity-z [zonefieldoptions]

Paint the \(z\)-velocity at the gridpoint.

Block of Common Zone Field Modifier Options

The following modifiers are available to specify additional information for the geometry paint-extra keywords. The following keywords are available. acceleration, acceleration-x, acceleration-y, acceleration-z, condition, convergence, density, density-fluid, displacement, displacement-x, displacement-y, displacement-z, extra, fluid-biot-modulus, fluid-bulk-modulus, multiplier, pore-pressure, property, property-fluid, property-thermal, ratio-local, ratio-target, saturation, strain-increment, strain-increment-xx, strain-increment-xy, strain-increment-xz, strain-increment-yy, strain-increment-yz, strain-increment-zz, strain-rate, strain-rate-xx, strain-rate-xy, strain-rate-xz, strain-rate-yy, strain-rate-yz, strain-rate-zz, strength-stress-ratio, stress, stress-effective, stress-effective, stress-effective-xx, stress-effective-xy, stress-effective-xz, stress-effective-yy, stress-effective-yz, stress-effective-zz, stress-xx, stress-xy, stress-xz, stress-yy, stress-yz, stress-zz, temperature, timestep-dynamic, unbalanced-force, unbalanced-force-x, unbalanced-force-y, unbalanced-force-z, velocity, velocity-x, velocity-y and velocity-z. factor-of-safety.

component keyword

This keyword selects which scalar to retrieve from a vector type value, such as velocity or displacement. If the value type is not vector, this setting is ignored. The available options are:

x

Get the \(x\)-component of the vector.

y

Get the \(y\)-component of the vector

z

Get the \(z\)-component of the vector

magnitude

Get the vector magnitude.

index i

For keywords that require it (most notably extra), this specifies the index that should be used. The default value will be 1.

gravity b

If on, then gravitational forces are included in the returned applied force. The default is off.

label s

Assign a label to the history (used in prints and plots).

log b

If on, the returned number is the base 10 log of the absolute value of the original value. The default is off.

method

This specifies the method of calculation used to bring zone-based quantities to arbitrary locations in space (including at gridpoint positions).

constant

Assumes values are constant inside zones. This is the default option. Values at gridpoints or at zone boundaries will pick one adjacent zone to use.

average

This uses an volume weighted average of all the zones connected to the gridpoint.

inverse-distance-weight

This uses a weighted average of up to 32 zones in the immediate vicinity of the point. The weighting is determined by a power of the distance of the zone centroid from the specified point.

power f

Specify the power of the distance used to weight values. The default power is 3.0.

radius-ratio f

Specify the ratio of the maximum distance from the point of the zones selected, to the ratio used to calculate weighted values. Zones farther from this value are discounted. The default value is 0.75.

polynomial <tolerance f >

Use a fit to a polynomial function based on the zones in the vicinity of the point. Degenerate degrees of freedom are detected and removed. The optional tolerance flag can be used to change the value used to detect a degenerancy. The default value is 1e-7.

name s

Certain keywords (most notably property) require a name value to be fully specified. This will determine the specific property name retrieved.

null

Specify the criteria used to ignore zone values. By default mechanical null zones are ignored.

fluid b

Zones with a null fluid constitutive model are also ignored if this is set to on.

mechanical b

Zones with a null mechanical constitutive model are ignored if this is set to on (this is the default).

thermal b

Zones with a null thermal constitutive model are ignored if this is set to on.

quantity keyword

This keyword selects which scalar to retrieve from a symmetric tensor type value, such as stress or strain. If the value type is not a tensor, this setting is ignored. The available options are:

intermediate

Get the intermediate principal stress.

maximum

Get the maximum (most positive) value of principal stress. [CS: doc needs to be added for this to work in PFC] Note that in -flac3d- ref-compressive stresses are negative <stresssignconventions>-.

mean

Get the mean pressure value, defined as the trace of the tensor divided by 3. For stresses this is most often referred to as the pressure.

minimum

Get the minimum (most negative) principal stress. [CS: doc needs to be added for this to work in PFC] Note that in -flac3d- ref-compressive stresses are negative <stresssignconventions>-.

norm

Get the norm of the strain rate. [CS: again, we need a doc from FLAC3D for this to work in PFC]; see the equation in ref-sec_zonefielddatanames-.

octahedral

Get octahedral stress. [CS: again, we need a doc from FLAC3D for this to work in PFC]; see the equation in ref-sec_zonefielddatanames-.

shear-maximum

Get the maximum shear stress.

total-measure

Get the distance of tensor value to the origin in principal space.

volumetric

Get the volumetric change, or trace.

von-mises

Get the Von Mises measure. [CS: again, we need a doc from FLAC3D for this to work in PFC]; see the equation in ref-sec_zonefielddatanames-.

xx

Get the xx-component of the tensor.

xy

Get the xy-component of the tensor.

xz

Get the xz-component of the tensor.

yy

Get the yy-component of the tensor.

yz

Get the yz-component of the tensor.

zz

Get the zz-component of the tensor.

source keyword

Certain keywords (like extra and pore-pressure) can be retrieved either from the zone structure or from the gridpoint structure. The default value is gridpoint.

gridpoint

Values are retrieved directly from the gridpoint.

zone

Values are retrieved from the zone.

stress b

A few of the tensor type quantity options do different things depending if the value is considered a stress. When coming from a value like extra, this cannot be determined automatically. This allows the user to specify that the incoming tensor value should be considered a stress quantity.

type keyword

In certain cases the type (scalar, vector, or tensor) of the value cannot necessarily be determined ahead of time. Extra variables, for example, can hold values of all three types. This keyword allows one to specify which type it is assumed to be. If the original value type does not match, 0.0 is returned.

scalar

Set type to scalar float. This is the default.

vector

Set type to vector.

tensor

Set type to tensor.

velocity-limit f

Specifies the velocity limit used to determine if an object is stable or not for the factor-of-safety value. The default value is 1e-4.