SnapshotsGenerator.SpaceOpEvals Class Reference

Detailed Description

Implementation of a SnapshotsGenerator.Cached for empirical basis generation. The generate() method returns the evaluations of an operator or a function on the solution (trajectory) of a detailed simulation.

An SpaceOpEvals depends on a SnapshotsGenerator.Cached providing detailed simulation (trajectories) on which the operator can be applied.

Definition at line 18 of file SpaceOpEvals.m.

Inheritance diagram for SnapshotsGenerator.SpaceOpEvals:

Collaboration diagram for SnapshotsGenerator.SpaceOpEvals:

Public Member Functions
	SpaceOpEvals (IDetailedModel dmodel, id,SnapshotsGenerator.Cached rbdgen,ILocalizedOperator ophandle, force_delete, enable_caching)
	constructor for a snapshot generator of space operator evaluations. More...
function SnapshotsGenerator.MergedSpaceOpEvals combination =	plus (SnapshotsGenerator.SpaceOpEvals other)
	convenience function allowing to merge several SnapshotsGenerator.SpaceOpEvals instances together by "adding" them together with a + operator. 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
ILocalizedOperator	ophandle
	a localized operator 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 [ LU , 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...
function LU =	generate_ei_impl (IDetailedModel dmodel,IDetailedData detailed_data, U)
	generates operator evaluations for snapshots generated by the underlying rb_detailed_generator object. More...

Protected Attributes
::SnapshotsGenerator.Trajectories	rb_detailed_generator
	an object providing a generator for detailed_simulations

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.SpaceOpEvals.SpaceOpEvals	(	IDetailedModel	dmodel,
			id,
		SnapshotsGenerator.Cached	rbdgen,
		ILocalizedOperator	ophandle,
			force_delete,
			enable_caching
	)

constructor for a snapshot generator of space operator evaluations.

Parameters

dmodel	object specifying how the high dimensional data can be computed.
id	a unique string identifier for this object.
rbdgen	an underlying object generating snapshots \(\{u_h^k(\mu)\}_{k=1}^K\) for which the space operator evaluations \(\{ {\cal L}_h(\mu)[u_h^k(\mu)] \}_{k=1}^K\) shall be computed.
ophandle	an localized operator or a function_handle with synopsis op(descr, model_data, U, NU_ind) implementing the operator \({\cal L}_h\).
force_delete	boolean value indicating whether the cached data shall be automatically deleted if its inconsistent with the given dmodel. (Default = true)
enable_caching	boolean value indicating whether the generated data shall be stored in a cache. (Default = true)

Definition at line 57 of file SpaceOpEvals.m.

Member Function Documentation

function LU = SnapshotsGenerator.SpaceOpEvals.generate_ei_impl ( IDetailedModel  dmodel, IDetailedData  detailed_data,   U  )

protected

generates operator evaluations for snapshots generated by the underlying rb_detailed_generator object.

Parameters

dmodel	object specifying how the high dimensional data can be computed.
detailed_data	object 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.
U	a matrix of size ndofs x K with snapshots generated by the underlying rb_detailed_generator.

Return values

LU	a matrix of size ndofs x K with the operator evaluations.

Required fields of dmodel:

• descr —  descr
• debug —  debug
• get_dofs_at_time —  get dofs at time

Definition at line 126 of file SpaceOpEvals.m.

Here is the call graph for this function:

Here is the caller graph for this function:

function [LU , opt_fields ] = SnapshotsGenerator.SpaceOpEvals.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

fields	cell 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.
dmodel	object specifying how the high dimensional data can be computed.
detailed_data	object 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

U	a matrix with DOF vector columns holding the generated snapshots.
opt_fields	optional fields to be cached.

Implements SnapshotsGenerator.Cached.

Definition at line 116 of file SpaceOpEvals.m.

Here is the call graph for this function:

function SnapshotsGenerator.MergedSpaceOpEvals combination = SnapshotsGenerator.SpaceOpEvals.plus

(

SnapshotsGenerator.SpaceOpEvals

other

)

convenience function allowing to merge several SnapshotsGenerator.SpaceOpEvals instances together by "adding" them together with a + operator.

Parameters

other

an "addend"

Return values

combination

the merged object

Definition at line 97 of file SpaceOpEvals.m.

Member Data Documentation

SnapshotsGenerator.SpaceOpEvals.ophandle

a localized operator

Note

This property has non-standard access specifiers: SetAccess = Protected, GetAccess = Public

Matlab documentation of property attributes.

Definition at line 44 of file SpaceOpEvals.m.

---

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

• rbasis/basisgen/oop/+SnapshotsGenerator/SpaceOpEvals.m