rbmatlab  1.13.10
 All Classes Namespaces Files Functions Variables Groups Pages
List of all members | Public Member Functions | Protected Member Functions
SnapshotsGenerator.Trajectories Class Reference

Detailed Description

Implementation of a SnapshotsGenerator.Cached for reduced basis generation. The generate() method returns a detailed simulation.

Definition at line 18 of file Trajectories.m.

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

Public Member Functions

 Trajectories (IDetailedModel dmodel, id, force_delete, enable_caching)
 constructor for a snapshot generator creating trajectories of DOF vectors by a IDetailedModel.detailed_simulation() call.
 
- Public Member Functions inherited from SnapshotsGenerator.Cached
 Cached (IDetailedModel dmodel, id, force_delete, enable_caching)
 constructor for the detailed generator
 
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.
 
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
 
function  prepare (IDetailedModel dmodel,IDetailedData detailed_data, M)
 precompute detailed data for all parameters given by M.
 
function IDetailedModel dmodel = get_underlying_model ()
 returns the detailed model stored on the harddrive with which the snaphshots were generated.
 

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.
 

Additional Inherited Members

- Public Attributes inherited from SnapshotsGenerator.Cached
 idname
 unique name created from the IDs as given to the constructor.
 
 id
 string identifier for this generator
 
 enable_caching = true
 boolean flag indicating whether caching is enabled.
 
 model_name = "default"
 name id of DetailedModel
 
 force_delete = true
 boolean value indicating whether the cached data shall be automatically deleted if its inconsistent with the given dmodel.
 
 countdown = 5
 seconds to wait before cached data is deleted automatically in case of inconsistent models.
 
 is_valid
 checks whether the basis generator points to a valid directory
 
- 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.
 

Constructor & Destructor Documentation

SnapshotsGenerator.Trajectories.Trajectories ( IDetailedModel  dmodel,
  id,
  force_delete,
  enable_caching 
)

constructor for a snapshot generator creating trajectories of DOF vectors by a IDetailedModel.detailed_simulation() call.

Parameters
dmodelobject specifying how the high dimensional data can be computed.
ida unique string identifier for this object.
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 29 of file Trajectories.m.

Member Function Documentation

function [U , opt_fields ] = SnapshotsGenerator.Trajectories.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 60 of file Trajectories.m.


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