Classes | Public Member Functions | Static Public Member Functions | List of all members
foamPvCore Class Reference
Inheritance diagram for foamPvCore:
[legend]

Classes

class  arrayRange
 Bookkeeping for GUI checklists and multi-block organization. More...
 

Public Member Functions

constexpr foamPvCore () noexcept
 Construct null. More...
 

Static Public Member Functions

static Ostream & printDataArraySelection (Ostream &os, vtkDataArraySelection *select)
 Print information about vtkDataArraySelection. More...
 
static void addToBlock (vtkMultiBlockDataSet *output, vtkDataSet *dataset, const arrayRange &selector, const label datasetNo, const std::string &datasetName)
 Convenience method for the VTK multiblock API. More...
 
template<class StringType >
static label addToArray (vtkDataArraySelection *select, const std::string &prefix, const UList< StringType > &names)
 Add names to array selection. More...
 
template<class StringType >
static label addToArray (vtkDataArraySelection *select, const UList< StringType > &names, const std::string &suffix=string::null)
 Add names to array selection. More...
 
template<class Type >
static label addToSelection (vtkDataArraySelection *select, const std::string &prefix, const IOobjectList &objects)
 Add objects of Type to array selection. More...
 
template<class Type >
static label addToSelection (vtkDataArraySelection *select, const IOobjectList &objects, const std::string &suffix=string::null)
 Add objects of Type to array selection. More...
 
template<class Type >
static label addToSelection (vtkDataArraySelection *select, const std::string &prefix, const HashTable< wordHashSet > &objects)
 Add objects of Type to array selection. More...
 
template<class Type >
static label addToSelection (vtkDataArraySelection *select, const HashTable< wordHashSet > &objects, const std::string &suffix=string::null)
 Add objects of Type to array selection. More...
 
static wordHashSet getSelected (vtkDataArraySelection *select)
 
static wordHashSet getSelected (vtkDataArraySelection *select, const labelRange &selector)
 
static HashSet< string > getSelectedArraySet (vtkDataArraySelection *select)
 Retrieve the currently enabled selections as hashset. More...
 
static Map< string > getSelectedArrayMap (vtkDataArraySelection *select)
 Retrieve the currently enabled selections as id/name map. More...
 
template<class AnyValue , class AnyHasher >
static void setSelectedArrayEntries (vtkDataArraySelection *select, const HashTable< AnyValue, string, AnyHasher > &enabled)
 Enable the selection(s) More...
 
static word getFoamName (const std::string &str)
 Extract the first word characters after a slash. More...
 
static void printMemory ()
 Simple memory used debugging information. More...
 

Detailed Description

Definition at line 71 of file foamPvCore.H.

Constructor & Destructor Documentation

◆ foamPvCore()

constexpr foamPvCore ( )
inlineconstexprnoexcept

Construct null.

Definition at line 175 of file foamPvCore.H.

Member Function Documentation

◆ printDataArraySelection()

static Ostream& printDataArraySelection ( Ostream &  os,
vtkDataArraySelection *  select 
)
static

Print information about vtkDataArraySelection.

◆ addToBlock()

static void addToBlock ( vtkMultiBlockDataSet *  output,
vtkDataSet *  dataset,
const arrayRange &  selector,
const label  datasetNo,
const std::string &  datasetName 
)
static

Convenience method for the VTK multiblock API.

◆ addToArray() [1/2]

static label addToArray ( vtkDataArraySelection *  select,
const std::string &  prefix,
const UList< StringType > &  names 
)
static

Add names to array selection.

◆ addToArray() [2/2]

static label addToArray ( vtkDataArraySelection *  select,
const UList< StringType > &  names,
const std::string &  suffix = string::null 
)
static

Add names to array selection.

◆ addToSelection() [1/4]

static label addToSelection ( vtkDataArraySelection *  select,
const std::string &  prefix,
const IOobjectList &  objects 
)
static

Add objects of Type to array selection.

◆ addToSelection() [2/4]

static label addToSelection ( vtkDataArraySelection *  select,
const IOobjectList &  objects,
const std::string &  suffix = string::null 
)
static

Add objects of Type to array selection.

◆ addToSelection() [3/4]

static label addToSelection ( vtkDataArraySelection *  select,
const std::string &  prefix,
const HashTable< wordHashSet > &  objects 
)
static

Add objects of Type to array selection.

◆ addToSelection() [4/4]

static label addToSelection ( vtkDataArraySelection *  select,
const HashTable< wordHashSet > &  objects,
const std::string &  suffix = string::null 
)
static

Add objects of Type to array selection.

◆ getSelected() [1/2]

static wordHashSet getSelected ( vtkDataArraySelection *  select)
static

Retrieve the current selections as a wordHashSet, while stripping off any prefix or suffix

◆ getSelected() [2/2]

static wordHashSet getSelected ( vtkDataArraySelection *  select,
const labelRange &  selector 
)
static

Retrieve sub-list of the current selections as a wordHashSet, while stripping off any prefix or suffix

◆ getSelectedArraySet()

static HashSet<string> getSelectedArraySet ( vtkDataArraySelection *  select)
static

Retrieve the currently enabled selections as hashset.

◆ getSelectedArrayMap()

static Map<string> getSelectedArrayMap ( vtkDataArraySelection *  select)
static

Retrieve the currently enabled selections as id/name map.

◆ setSelectedArrayEntries()

static void setSelectedArrayEntries ( vtkDataArraySelection *  select,
const HashTable< AnyValue, string, AnyHasher > &  enabled 
)
static

Enable the selection(s)

◆ getFoamName()

static word getFoamName ( const std::string &  str)
static

Extract the first word characters after a slash.

◆ printMemory()

static void printMemory ( )
static

Simple memory used debugging information.

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