ball cfd history command

Syntax

ball cfd history <name s > keyword ...

Primary keywords:

extra    force    xforce    yforce    zforce

Add a ball CFD history.

A history is a floating point variable that can be sampled and stored during a model run. The optional i directly following history creates a history with the specified ID. If not specified, then the next available history ID is used. Following one of the keywords given below, either 1) an additional id keyword followed by an integer id, or 2) an additional position keyword followed by a position vector v must be given to define the specific cfd ball. Review the common c history commands for details regarding the manipulation of histories.

extra [ballcfdhistoryblock]

Take a history of an extra variable. Use index to specify the extra index and type to specify the type.

force [ballcfdhistoryblock]

Magnitude of the force resulting from fluid interactions.

xforce [ballcfdhistoryblock]

The \(x\)-component of the force resulting from fluid interactions.

yforce [ballcfdhistoryblock]

The \(y\)-component of the force resulting from fluid interactions.

zforce [ballcfdhistoryblock]

The \(z\)-component of the force resulting from fluid interactions.


ball cfd history Keyword Block

The following modifiers are available to specify addition information for the ball cfd history keywords. They will not modify history values to which they are not applicable. In other words, the component keyword will not modify scalar or tensor values. extra, force, xforce, yforce and zforce.

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 a vector, this setting is ignored. The available options are:

x
Record the \(x\)-component of the vector.
y
Record the \(y\)-component of the vector.
z (3D ONLY)
Record the \(z\)-component of the vector.
magnitude
Record the vector magnitude.
id i

Record the history of cfd ball with ID i.

index i

For keywords that require it (most notably extra), this specifies the index that should be used.

log b

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

position v

Record the history of cfd ball either containing or closest to position v.

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 (3D ONLY)

Record the intermediate principal value of the tensor.

maximum

Record the maximum (most positive) principal value of the tensor. Note that compressive stresses are negative.

mean

Record the mean value, defined as the trace of the tensor divided by { 2 in 2D; 3 in 3D}. For stresses this is most often referred to as the pressure.

minimum

Record the minimum (most negative) principal value of the tensor. Note that compressive stresses are negative.

norm

Record the norm of the full tensor. This is defined as the sum of each tensor component squared.

octahedral (3D ONLY)

Record the octahedral measure of the tensor.

shear-maximum

Record the maximum shear value.

total-measure (3D ONLY)

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

volumetric

Record the volumetric change, or trace of the tensor.

von-mises (3D ONLY)

Record the Von Mises measure.

xx

Record the xx-component of the tensor.

xy

Record the xy-component of the tensor.

xz (3D ONLY)

Record the xz-component of the tensor.

yy

Record the yy-component of the tensor.

yz (3D ONLY)

Record the yz-component of the tensor.

zz (3D ONLY)

Record the zz-component of the tensor.

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

Specify a scalar float type.

tensor

Specify a tensor type.

vector

Specify a vector type.