rbmatlab  1.16.09
 All Classes Namespaces Files Functions Variables Modules Pages
List of all members | Public Member Functions
Greedy.DataTree.Detailed.ILeafNode Class Reference

Detailed Description

interface specialization for a leaf element in a DataTree returned by the Greedy basis generation algorithms

Definition at line 20 of file ILeafNode.m.

Inheritance diagram for Greedy.DataTree.Detailed.ILeafNode:
Inheritance graph
[legend]
Collaboration diagram for Greedy.DataTree.Detailed.ILeafNode:
Collaboration graph
[legend]

Public Member Functions

 ILeafNode (ModelData model_data)
 constructor for such a leaf element More...
 
- Public Member Functions inherited from Greedy.DataTree.Detailed.INode
function  set_rb (RB)
 sets the reduced basis space More...
 
function RB = get_rb ()
 returns the reduced basis space More...
 
function  snapshot (id, id_text, snapshot_description)
 creates a copy of the Greedy.Info element of the subtree rooted by this node and stores it in a history. More...
 
function sl = get_snapshot_length (id)
 returns the number of history entries stored for a specific id. More...
 
function fs = format_snapshot (id, indices)
 retuns a formatted structure of a history item for several indices More...
 
virtual function siz = get_rb_size ()
 returns the size of the reduced basis stored in this tree. More...
 
virtual function DataTree.IdMapNode siz = get_ei_size ()
 returns the size of the collateral reduced basis stored in this tree. More...
 
virtual function [
ot1
, ot2
, ot3 ] = 
offtime (IReducedModel rmodel)
 returns up to three different offline time measurements More...
 
- Public Member Functions inherited from DataTree.INode
virtual function DataTree.INode tree = create_tree (DataTree.ICreator creator, ids, mu_cube, tslice, basepath)
 Creates a new tree from a subtree specified by ids, parameter and time index regions. More...
 
virtual function this = set (index, value)
 Sets a child at the given path in the tree hierarchy. More...
 
function  leaf_func (funcptr, ids, mu_cube, tslice)
 applies a function to all leafs of a DataTree More...
 
function tree = create_scalar_tree (funcptr, ids, mu_cube, tslice)
 copies the current trees with different leafs. These leafs are computes by a function returning scalar values. More...
 
function
start_index = 
traverse_start ()
 Start iterator for a full traverse of the DataTree. More...
 
function
next_index = 
traverse_next (this_index)
 iterator for a full traverse of the DataTree. More...
 
function
description = 
get_active_leaf_description (IModel model, ids)
 returns an enumeration of all leaves' basepath index vectors with a description of their parents. More...
 
function
description = 
get_leaf_description (ids, mu_cube, tslice)
 returns an enumeration of all leaves' basepath index vectors with a description of their parents. More...
 
function tstop = index_valid_till (index)
 Returns the last valid time step index of a time slice. More...
 
function INode data = get_by_description (id, mu, nt)
 A combination of get_index() and get() More...
 
function
active_leaf_index = 
get_active_leaf_index (IModel model, id)
 retuns the leaf element index for the current IDetailedModel configuration. More...
 
function DataTree.LeafNode
active_leaf = 
get_active_leaf (IModel model, id)
 retuns the leaf element for the current IDetailedModel configuration. More...
 
function  display (fn, basepath, name)
 overwrites the standard display method for DataTree objects More...
 
function lines = disp_node (basepath, fn)
 returns a cell array of strings with information on the node. More...
 
- Public Member Functions inherited from Greedy.DataTree.Info
function  append_field (fieldname, value)
 appends a value to an information field storing a vector More...
 
function  set_field (fieldname, value)
 sets an information field More...
 
function value = get_field (fieldname, default)
 returns the value of an information field More...
 
function value = get_field_on_active_child (fieldname,IModel model, id)
 returns the value of an information field from the active leaf node More...
 
function  set_fields (other, fns)
 copies fields from another struct More...
 
function  set_stop_flag (flag, on_off)
 sets the stop flag in this node More...
 
function  propagate_stop_flag (flag, on_off)
 updates the stop flag in all children nodes of the current one. More...
 
function
stopped_flags = 
stopped_on_active_child (flags,IModel model, id)
 returns stop flags set on the active child More...
 
function
stopped_flags = 
stopped_on_any_child (flags)
 returns stop flags set on any child of the current node More...
 
function
stopped_flags = 
stopped_on_all_leafs (flags)
 returns stop flags set on all children nodes of the current node More...
 
- Public Member Functions inherited from DataTree.ILeafNode
function
children = 
length ()
 Returns the number of children of the node. More...
 
function index = get_index (dummy2, dummy3, dummy)
 Obtains the leaf index vector that best fits the child description given by the three arguments. More...
 
function this = set (dummy2,DataTree.INode value)
 Sets a child at the given path in the tree hierarchy. More...
 
function data = get (index)
 Access to a child of the current node. More...
 
function DataTree.ILeafNode node = get_active_leaf (DataTree.IModel model, id)
 retuns the leaf element for the current IDetailedModel configuration. More...
 
function tree = create_tree (creator, ids, mu_cube, tslice, basepath)
 Creates a new tree from a subtree specified by ids, parameter and time index regions. More...
 
- Public Member Functions inherited from IDetailedData
 IDetailedData (BasisGenDescr bg_descr, model_data)
 constructor generating the reduced basis spaces More...
 
function ret = subsref (S)
 forwarding of fieldnames access to the underlying model_data struct More...
 
virtual function
rb_size = 
get_rb_size (IReducedModel rmodel)
 returns the dimension of the stored reduced basis space. More...
 

Additional Inherited Members

- Public Attributes inherited from Greedy.DataTree.Detailed.INode
 history
 storage of history entries (c.f. snapshot() and format_snapshot() )
 
- Public Attributes inherited from Greedy.DataTree.Info
 fields = "[]"
 a dynamically growing structure of information fields More...
 
 stop_flags = {""}
 a cell array of strings describing why the generation of this node terminated. More...
 
- Public Attributes inherited from IDetailedData
BasisGenDescr bg_descr
 struct describing how the basis shall be generated. More...
 
::ModelData model_data
 struct holding \(H\)-dimensional model data, which is needed for an IDetailedModel.detailed_simulation(), e.g. a grid object.
 
- Protected Member Functions inherited from Greedy.DataTree.Detailed.INode
function  snapshot_children (id, id_text, snapshot_description)
 forward the snapshot generation to the children More...
 
function
children = 
gather_children_format_snapshot (id, indices)
 helper function called by format_snapshot() More...
 

Constructor & Destructor Documentation

Greedy.DataTree.Detailed.ILeafNode.ILeafNode ( ModelData  model_data)

constructor for such a leaf element

Parameters
model_dataMatlab structure storing (possibly) high dimensional data needed by IDetailedModel.detailed_simulation().

Definition at line 33 of file ILeafNode.m.

Here is the call graph for this function:


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