rbmatlab  1.16.09
 All Classes Namespaces Files Functions Variables Modules Pages
List of all members | Public Member Functions | Public Attributes | Protected Member Functions
SnapshotsGenerator.Random Class Reference

Detailed Description

creates random Dof vectors (for testing purposes only!)

Definition at line 18 of file Random.m.

Inheritance diagram for SnapshotsGenerator.Random:
Inheritance graph
[legend]
Collaboration diagram for SnapshotsGenerator.Random:
Collaboration graph
[legend]

Public Member Functions

 Random (IDetailedModel dmodel, id, ranges, force_delete, enable_caching)
 constructor for the random detailed generator More...
 
- Public Member Functions inherited from SnapshotsGenerator.Cached
 Cached (IDetailedModel dmodel, id, force_delete, enable_caching)
 constructor for the detailed generator More...
 
function  clear_cachedirectory ()
 clears the directory containing the cached mat-files
 
function  assert_model_is_consistent (IDetailedModel dmodel, comparemodel)
 throws an inconsistency error if the the current IDetailedModel object and the one stored on the harddrive differ. More...
 
function [
detailed_sample
, tictoc
,
opt_fields ] = 
generate (IDetailedModel dmodel,IDetailedData detailed_data, fields)
 generates a detailed data sample for a specific parameter using caching facilities More...
 
function  prepare (IDetailedModel dmodel,IDetailedData detailed_data, M)
 precompute detailed data for all parameters given by M. More...
 
function IDetailedModel dmodel = get_underlying_model ()
 returns the detailed model stored on the harddrive with which the snaphshots were generated. More...
 

Public Attributes

 ranges = "[0 1]"
 min-max vector indicating the range for the random values of the generated Dof-values. More...
 
- Public Attributes inherited from SnapshotsGenerator.Cached
 idname
 unique name created from the IDs as given to the constructor. More...
 
 id
 string identifier for this generator More...
 
 enable_caching = true
 boolean flag indicating whether caching is enabled. More...
 
 model_name = "default"
 name id of DetailedModel More...
 
 force_delete = true
 boolean value indicating whether the cached data shall be automatically deleted if its inconsistent with the given dmodel. More...
 
 countdown = 5
 seconds to wait before cached data is deleted automatically in case of inconsistent models. More...
 
 is_valid
 checks whether the basis generator points to a valid directory More...
 

Protected Member Functions

function [ U
,
opt_fields ] = 
generate_impl (IDetailedModel dmodel,IDetailedData detailed_data, fields)
 generates a sample trajectory or detailed simulation item from which a new basis function can be generated. More...
 

Additional Inherited Members

- Static Protected Member Functions inherited from SnapshotsGenerator.Cached
static function
hashcode = 
hashcode (IDetailedModel dmodel)
 this is a very simple hash code, generating an md5 hash out of the current parameter vector. More...
 

Constructor & Destructor Documentation

SnapshotsGenerator.Random.Random ( IDetailedModel  dmodel,
  id,
  ranges,
  force_delete,
  enable_caching 
)

constructor for the random detailed generator

Parameters
dmodelobject specifying how the high dimensional data can be computed.
idan identifier string
rangesmin-max vector indicating the range for the random values of the generated Dof-values. (Default = [0 1])
force_deleteboolean value indicating whether the cached data shall be automatically deleted if its inconsistent with the given dmodel. (Default = true)
enable_cachingboolean value indicating whether the generated data shall be stored in a cache. (Default = true)

Definition at line 40 of file Random.m.

Member Function Documentation

function [U , opt_fields ] = SnapshotsGenerator.Random.generate_impl ( IDetailedModel  dmodel,
IDetailedData  detailed_data,
  fields 
)
protectedvirtual

generates a sample trajectory or detailed simulation item from which a new basis function can be generated.

Parameters
fieldscell array of structure field names which shall also be stored in the cache in the opt_fields structure. If not given only the U is generated.
dmodelobject specifying how the high dimensional data can be computed.
detailed_dataobject defining the basis generation algorithm and storage for storing high dimensional data, i.e. dependent on dimension \(H\). This data is necessary for detailed simulations, construction of online matrices, reduced_data and reconstruction of reduced simulations.
Return values
Ua matrix with DOF vector columns holding the generated snapshots.
opt_fieldsoptional fields to be cached.

Implements SnapshotsGenerator.Cached.

Definition at line 75 of file Random.m.

Here is the call graph for this function:

Member Data Documentation

SnapshotsGenerator.Random.ranges = "[0 1]"

min-max vector indicating the range for the random values of the generated Dof-values.


Default: "[0 1]"

Definition at line 28 of file Random.m.


The documentation for this class was generated from the following file: