UserComponents

A name for this component, up to 30 characters long. If the name is not unique, D3PLOT's behaviour will depend on the value of the 'if_existing' argument to this function.

One of the constants

• U_NODE for nodal data
• U_SOSH for solid, shell and thick shell data
• U_BEAM for beam data
• U_OTHR for LSDA (Other) data

One of the constants

• U_SCALAR for scalar data (any type)
• U_VECTOR for vector data (U_NODE, U_BEAM and U_OTHR only)
• U_TENSOR for tensor data (U_SOSH only)
• U_OTHR for LSDA (Other) data

Action to take if UBIN component 'component_name' already exists.

One of the constants

• REPLACE deletes the existing UBIN component, replacing it with this definition. This means that any existing data for the user-defined component of this name is deleted and the component is re-initialised.
• RENAME changes the 'component_name' argument of this function call by adding a suffix to make it unique, so the existing component of this name (and data) will be left unchanged and the new one will not clash with it.

What to do with the ".ubd" files when the model is closed or D3PLOT exits.

One of the constants

• LEAVE (default) will leave any ".ubd" files on disk so that they are available for any future D3PLOT sessions.
• DELETE will delete these files when then model is closed or D3PLOT exits.

If this argument is ommitted or set to zero then LEAVE behaviour is used. However alternative default behaviour may be specified by setting the preference

d3plot*ubd_file_dispose: to LEAVE or DELETE

Specify where the data for this component is to be stored, one of

• A valid <pathname> .ubd files will be written to this directory instead of the original analysis. This will usually be a better solution than the alternative options of keeping data "in core" since it allows D3PLOT memory management to operate normally, writing data to disk if space is needed in memory. The directory <pathname> must exist, and you must have write permission to it.
• JOBDIR(<pathname>) the path of the directory containing the results, in other words the default location for the files. However you can append a further <pathname> to this in order to specify a directory relative to JOBDIR, for example:
  • JOBDIR/.. Means the directory above the current results
  • JOBDIR/../../my_results Means two directories above, in the sub-directory 'my_results'
• IN_CORE stipulates that this component's data will always be held in memory, and will never be written to disk. This solves the problem of data files being in read-only directories since no .ubd files are written. However it also means that D3PLOT will not dump data for currently unused states to disk, meaning that you may run out of memory if you generate too much data in your JavaScripts.

If IN_CORE is used the value of 'dispose' above is ignored.

If this argument is omitted then the default behaviour of creating .ubd files in the same directory as the analysis database files will be used. However an alternative default directory may also be specified by the preference:

d3plot*ubd_file_location: <pathname> or IN_CORE or JOBDIR(<pathname>)

If both <location> and this preferenceare defined then <location> in this function call takes precedence.

Notes on pathnames:

1. On Windows platforms forward slash / and backslash \ can be used interchangeably in pathnames. On Linux platforms you must use forward slash / only, so in a multi-system environment it is recommended that you use forward slash syntax only.
2. If <pathname> contains white space then you must enclose the whole string in "...", for example "C:\my results".

// Create a component for nodal scalar data
var handle_1 = CreateUbinComponent("My nodal data", U_NODE, U_SCALAR, REPLACE);

// Create a tensor component for solid, shell and thick shell data
var handle_2 = CreateUbinComponent("My shell tensor data", U_SOSH, U_TENSOR, REPLACE);

Arguments

The handle of an existing UBIN component

// Delete the UBIN component handle_1
if(!DeleteUbinComponent(handle_1))
{
    ...deal with failure...
}

Arguments

The handle of an existing UBIN component as returned by CreateUbinComponent().

An item type constant, NODE, SOLID, SHELL, etc. This must match the underlying type of the UBIN component, thus NODE for components of type U_NODE, and so on. It is illegal to attempt to store data for a type that does not match the underlying UBIN component type thus, for example, you cannot store NODE data for a U_SOSH component.

If +ve, the internal item number starting at 1. If -ve, the external label of the item. Internal numbers will be many times faster to process.

Integration point: must be a +ve layer number (lowest = 1).

Or zero for item type / data component combinations that do not consider integration points in this context. (for example nodal displacements or beam forces).

Or, for fully integrated elements with on plan integration points, an object with properties "ip" and "op". For a further explanation see Defining the Integration point argument in GetData().

"Top", "Middle" and "Bottom" are not allowed in this context since "middle" is not directly readable in cases with an even number of points.

A value of 1 should normally be used for solid elements.

Note, from D3PLOT 11.0 onwards, the order of the integration points for SHELLS and TSHELLS is <int_pnt> 1->n: BOTTOM->TOP surface (so long as a ZTF file is present). See Section 13.8.2.2.

Prior to this they were in the order of the integration points output by Ansys LS-DYNA, e.g. for <maxint>=3 <int_pnt> 1 was the MIDDLE surface, <int_pnt> 2 was the BOTTOM surface and <int_pnt> 3 was the TOP surface.

Object has the following properties:

State number to be used. If omitted, the current state is used.

// Retrieve an array of tensor data for solid #27, which implies that the UBIN data
// component <handle_1> is of type U_SOSH, and that its data type is U_TENSOR.
dvec = GetUbinData(handle_1, SOLID, 27, 1);
sxx = dvec[0];
szx = dvec[5];

// Retrieve the scalar value of node #17, in state <istate>.
// This implies that the UBIN component <handle_2> is of type U_NODE and its data is U_SCALAR.
nval = GetUbinData(handle_2, NODE, 17, 0, istate);

Arguments

A name to search for, a character string up to 30 characters long. Component names are not case-sensitive, but searching only succeeds if an exact match is found.

Object with the following properties:

Return type

object

// Look for component "My nodal data" and put the result of a successful lookup in object 'udata'.
if(udata = LocateUbinComponent("My nodal data"))
{
    handle = udata.handle;
    ...
}
else
{
    ... deal with failure
}

Arguments

The handle of an existing UBIN component as returned by CreateUbinComponent().

An item type constant, NODE, SOLID, SHELL etc. This must match the underlying type of the UBIN component, thus NODE for components of type U_NODE, and so on. It is illegal to attempt to store data for a type that does not match the underlying UBIN component type thus, for example, you cannot store NODE data for a U_SOSH component.

If +ve, the internal item number starting at 1. If -ve, the external label of the item. Internal numbers will be many times faster to process.

Integration point: must be a +ve layer number (lowest = 1)

Or zero for item type / data component combinations that do not consider integration points in this context (for example nodal displacements or beam forces).

Or, for fully integrated elements with on plan integration points, an object with properties "ip" and "op". For a further explanation see Defining the Integration point argument in GetData().

"Top", "Middle" and "Bottom" are not allowed in this context since "middle" is not directly readable in cases with an even number of points.

A value of 1 should normally be used for solid elements.

Note from D3PLOT 11.0 onwards, the order of the integration points for SHELLS and TSHELLS is <int_pnt> 1->n: BOTTOM->TOP surface (so long as a ZTF file is present). See Section 13.8.2.2.

Prior to this they were in the order of the integration points output by Ansys LS-DYNA, e.g. for <maxint>=3 <int_pnt> 1 was the MIDDLE surface, <int_pnt> 2 was the BOTTOM surface and <int_pnt> 3 was the TOP surface.

Object has the following properties:

The data to be stored. Its format depends on the "data type" of the component:

U_SCALAR: Scalar or array of length >=1

U_VECTOR: Array of length >= 3

U_TENSOR: Array of length >= 6

The alignment of array members should be as follows:

Vector: [X, Y, Z]

Tensor: [XX, YY, ZZ, XY, YZ, ZX]

State number to be used. If omitted, the current state is used.

// Write an array of tensor data for solid #27, which implies that the UBIN data component <handle_1>
// is of type U_SOSH,and that its data type is U_TENSOR.
dvec = new Array(6);
dvec[XX] = sxx;
dvec[YZ] = syz;
PutUbinData(handle_1, SOLID, 27, 1, dvec);

// Write the scalar value 19.5 for node #17, in state <istate>.
// This implies that the UBIN component <handle_2> is of type U_NODE and its data is U_SCALAR.
PutUbinData(handle_2, NODE, 17, 0, 19.5, istate);