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

Detailed Description

very simple detailed data tree node with only one child

Todo:
Do I need it? If yes, document it.

Definition at line 20 of file InfoNode.m.

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

Public Member Functions

 InfoNode (child, name)
 constructor for this node More...
 
function siz = get_rb_size ()
 returns the size of the reduced basis stored in this tree. More...
 
function siz = get_ei_size ()
 returns the size of the collateral reduced basis stored in this tree. More...
 
function data = get (index)
 Access to a child of the current node. More...
 
function [ ot1
, ot2
, ot3 ] = 
offtime (IReducedModel rmodel)
 returns up to three different offline time measurements More...
 
function index = get_index (id, mu, nt)
 Obtains the leaf index vector that best fits the child description given by the three arguments. 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...
 
function
children = 
length ()
 Returns the number of children of the node. More...
 
function this = set (index, value)
 Sets a child at the given path in the tree hierarchy. 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...
 
- 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...
 
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 Attributes

 child
 handle to the only child
 
 name
 a descriptive name for the node
 
- 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...
 

Additional Inherited Members

- 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.InfoNode.InfoNode (   child,
  name 
)

constructor for this node

Parameters
childchild
namename

Definition at line 52 of file InfoNode.m.

Member Function Documentation

function tree = Greedy.DataTree.Detailed.InfoNode.create_tree (   creator,
  ids,
  mu_cube,
  tslice,
  basepath 
)

Creates a new tree from a subtree specified by ids, parameter and time index regions.

The method creates a new DataTree for all nodes tagged by an id in ids, lying in the time slice given by tslice and inside the parameter space region given by mu_rect. At each of these nodes a method from a creator is called to build the tree.

Parameters
creatoran object creating the new tree.
idsa cell array of ids which shall be filtered. An empty cell array means that all ids are accepted. (default = [])
mu_cubea 1x2-cell array of vectors { lower_left, upper_right } specifying the lower left and the upper right corner of a cube in the parameter space for filtering parameter vectors. An empty array disables the filtering (default = []).
tslicea 2D vector specifying an interval of time step indices for time slicing. An empty vector disables the filtering (default = [])
basepatha vector specifying the relation of the current node to the parent node at which the merge began.
Return values
treethe newly created tree

Definition at line 97 of file InfoNode.m.

function data = Greedy.DataTree.Detailed.InfoNode.get (   index)
virtual

Access to a child of the current node.

Access a children node by an index which is usually retrieved by a call to get_index()

Parameters
indexvector describing the father-child relation
Return values
datathe children node

Implements DataTree.INode.

Definition at line 75 of file InfoNode.m.

function siz = Greedy.DataTree.Detailed.InfoNode.get_ei_size ( )
virtual

returns the size of the collateral reduced basis stored in this tree.

Return values
siza tree of nodes which are objects of stored collateral reduced basis spaces \({\cal W}^{{\cal L}_h}_{\text{red}}\) for operators \({\cal L}_h\)

Implements Greedy.DataTree.Detailed.INode.

Definition at line 70 of file InfoNode.m.

function index = Greedy.DataTree.Detailed.InfoNode.get_index (   id,
  mu,
  nt 
)
virtual

Obtains the leaf index vector that best fits the child description given by the three arguments.

Todo:
add get_indices method returning indices in a range

The leaf child description consists of an

  • id string,
  • a parameter vector and
  • a time step number.
Parameters
ida string id filtered through an DataTree.IdMapNode in the tree hierarchy.
mua parameter vector filtered through a DataTree.PpartNode instance in the tree hierarchy.
ntan integer corresponding to a time step index filtered through a DataTree.TpartNode instance in the tree hierarchy.
Return values
indexthe most-specific (longest possible) index vector leading to a DataTree.ILeafNode element matching the child description.

Implements DataTree.INode.

Definition at line 92 of file InfoNode.m.

function siz = Greedy.DataTree.Detailed.InfoNode.get_rb_size ( )
virtual

returns the size of the reduced basis stored in this tree.

Return values
sizdimension of stored reduced basis space \({\cal W}_{\text{red}}\)

Implements Greedy.DataTree.Detailed.INode.

Definition at line 65 of file InfoNode.m.

function children = Greedy.DataTree.Detailed.InfoNode.length ( )
virtual

Returns the number of children of the node.

For leaf elements this method should return 0.

Return values
childrenthe number of childres of the current node

Implements DataTree.INode.

Definition at line 124 of file InfoNode.m.

function [ot1 , ot2 , ot3 ] = Greedy.DataTree.Detailed.InfoNode.offtime ( IReducedModel  rmodel)
virtual

returns up to three different offline time measurements

Parameters
rmodelobject specifying how the reduced simulations can be computed.
Return values
ot1ot1
ot2ot2
ot3ot3

Implements Greedy.DataTree.Detailed.INode.

Definition at line 84 of file InfoNode.m.

function this = Greedy.DataTree.Detailed.InfoNode.set (   index,
  value 
)
virtual

Sets a child at the given path in the tree hierarchy.

Usually this method is used to set a leaf data node with attached data.

Parameters
indexthe path index where the node shall be injected
valuethe node that shall be attached as a child
Return values
thisthe modified DataTree node.

Implements DataTree.INode.

Definition at line 129 of file InfoNode.m.


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