stateVector.buildEnsemble
Builds members of a state vector ensemble
Syntax
Description
Builds N new members for a state vector ensemble.
Input Arguments
ens
scalar matfile object
A matfile object for use when writing ensemble members to file.
nMembers
scalar positive integer | ‘all’
The number of new ensemble members to build
strict
scalar logical
Whether to throw an error if the requested number of ensemble members cannot be built (true - default), or whether to permit a lesser number of ensemble members (false)
grids
struct array
A data source structure for the unique gridfiles used to build the ensemble members
coupling
scalar struct
Coupling parameters for the built ensemble
precision
‘single’ | ‘double’
The desired numerical precision of the new ensemble members.
header
string scalar
Header for thrown error IDs
Output Arguments
X
numeric array | []
If loading new members directly, the new ensemble members. If writing to file, an empty array.
obj
scalar stateVector object
The object updated with the new ensemble members