createh3dsubcase

Creates a subcase to be added to the H3D file. This is optional.

Syntax

subcaseID = createh3dsubcase(fid, subcase, sims_names, [, options])

subcaseID = createh3dsubcase(fid, subcase, steps, [, options])

subcaseID = createh3dsubcase(fid, subcase, sims_names, steps, [, options])

Inputs

fid
Integer representing the file ID.
Type: double | integer
subcase
Name of the subcase.
Type: char | string
sims_names
A string cell with simulation names. If no steps are provided, they will be considered as the index starting from 0 (0.0, 1.0, and so on).
Type: cell
timestep
Optional argument that specifies the timestep. Numeric steps associated for each simulation.
If no sims_names are provided, they will be created as "Timestep x.xxx", "Timestep y.yyy", and so on.
The timestep must be a numeric matrix of the same size as that of the iteration cell.
Type: matrix
options
complex
If the keyword “complex” is present, you can add complex data to the subcase.
datatypes
("all" (default) | string | scalar | matrix | string cell)
You can define which datatypes will be available in the subcase.
If "all" keyword is present, all previous datatypes will be added.
This is also true for all existing datatypes in append mode.
You can also provide the datatype index (indices in the matrix) or name (names in string cell).
Type: matrix

Outputs

subcaseID
Integer representing the ID of the subcase.

Examples

sidx1 =createh3dsubcase(idx, 'Subcase 2', {'SC2 Iteration 1' 'SC2 Iteration 2'}, [0.0 1.0]);
Create an H3D subcase with complex data (magnitude and phase):
sidx2 = createh3dsubcase(idx, 'Subcase 2', {'SC2 Iteration 1'},'complex');

Comments

When creating an H3D file in append mode, the createh3dsubcase command creates subcases with an ID starting at 1. The append mode should not be considered to add new subcases to an H3D file that already contains other subcases.

It is recommended to use either a model-only H3D file to append or create a new results-only H3D file.
Note: If two iterations for the same subcase have the same numeric timestep, only one will appear.
When writing complex data, real and imaginary parts are the inputs, which are internally converted to magnitude and phase in the H3D file, knowing that:
mag = sqrt(real^2+imag^2)
pha = atan(imag/real)