CIBC:Documentation:SCIRun:Reference:ModelCreation

From SCIRun Documentation Wiki
Jump to: navigation, search

ModelCreation Reference

Package Description


Module Reference

BreakPoint

InsertBundleBreakPoint
BreakPoint of Bundle flow. This module will buffer all input when it is blocked and will copy the input to the output when it is unblocked.
InsertFieldBreakPoint
BreakPoint of Field flow. This module will buffer all input when it is blocked and will copy the input to the output when it is unblocked.
InsertMatrixBreakPoint
BreakPoint of Matrix flow. This module will buffer all input when it is blocked and will copy the input to the output when it is unblocked.
InsertStringBreakPoint
BreakPoint of String flow. This module will buffer all input when it is blocked and will copy the input to the output when it is unblocked.

ChangeFieldData

CalculateDistanceToField
This module computes the minimum distance between the object and the nodes in field or the center of the elements.
CalculateDistanceToFieldBoundary
This module computes the minimum distance between the boundary of the field and the nodes in field or the center of the elements.
CalculateFieldData
This module computes a new scalar, vector or tensor array based upon a combination of scalars, vectors, and tensors.
CalculateInsideWhichField
This module detects whether a node or a cell is inside any of the object fields. The output field will be indexed according to the object it is in starting with index 1. Index 0 reserved for the part of the field not in any of the object fields.
CalculateIsInsideField
This module determines whether the points or the center of the elements are located within a volume defined by a volume mesh or by a closed surface.
CalculateSignedDistanceToField
This function needs an object field that is a volume or a closed surface. When inside the object the distance field is positive, when outside it is negative. The module will fail for not close surfaces as one cannot define inside and outside. Similarly this function will not work for objects that are lines or points. Use the DistanceToField module for these objects.
ComputeChangeFieldData
This module computes a new scalar, vector or tensor array based upon a combination of scalars, vectors, and tensors.
ConvertIndicesToFieldData
This module takes a field with inidices and puts the data indexed from a matrix in the field.
ConvertMappingMatrixToFieldData
This module puts the index of the original field onto the field.
CreateFieldData
This module creates data for a mesh. The module takes in a field, whose field data is discarded and a new field is generated basis on the same mesh.
GetFieldData
Get the data from the field and put it into a matrix.
MapCurrentDensityOntoField
This module maps potentials and conductivities into a current density field. The module samples the underlying fields and averages or integrates the data and puts the result on the elements of the output mesh. The module has the option to do the dot product with the current density field as well for surface destination meshes.
MapFieldDataFromElemToNode
Compute the value of the nodes based on the data from the adjoining elements. This module supports various operations to map element data to node data.
MapFieldDataFromNodeToElem
Compute the value of the elements based on the data from the adjoining elements. This module supports various operations to map node data to element data.
MapFieldDataGradientOntoField
This module maps the gradient on the destination field.
MapFieldDataOntoFieldNodes
This module takes a source field and maps it onto a destiation field. The module projects the data onto the nodes of the destination mesh.
ReportFieldDataMeasures
Calculate Sum, Average, Minimum, Maximum, etc of the field data.
SelectAndSetChangeFieldData
This module computes a new scalar, vector or tensor array based upon a combination of scalars, vectors, and tensors.
SelectAndSetFieldData
This module computes a new scalar, vector or tensor array based upon a combination of scalars, vectors, and tensors.
SetFieldData
Extract data from the matrix and insert it into the field.

ChangeMesh

CalculateLinkBetweenOppositeFieldBoundaries
This module will build a table which will indicate which nodes at the edges are connected to the opposite edges.
CalculateMeshNodes
This module computes a new node location based upon a combination of scalars, vectors, and tensors and other node positions.
ConvertMeshToPointCloud
Convert a field into a PointCloud field.
ConvertMeshToTetVol
Convert a field into a TetVolField.
ConvertMeshToTriSurf
This module converts a field into a TriSurfField.
ConvertToUnstructuredMesh
This module converts a field with a regular mesh into a field with an unstructured mesh.
FindClosestNodeIndex
Find an index per point of the closest node in the field.
FindClosestNodeIndexByValue
Find an index per point of the closest node with given value in the field.
GetBoundingBox
This module gets the bounding box of a field.
MergeMeshNodes
Merge nodes that are close together and remove double elements.
ScaleFieldMeshAndData
Scale Data and Geometry to match units.

Converter

ConvertMatricesToDipoleField
This module takes a matrix with locations and strengths and converts it into a pointcloud field with vectors.
ConvertMatrixToField
Convert a Matrix into a ImageMesh.
ConvertMatrixToString
ConvertMatrixToString prints the contents of a matrix into a string.
ConvertNrrdToField
Convert a NRRD into a SCIRun Field object.

CreateField

ClipFieldByFunction
This module can be used to clip of parts of a mesh, using a function which defines which parts are inside and which parts are outside of the clipping range.
ClipFieldByMesh
This module Clips a field by taking all the elements that are inside the object field.
ClipFieldBySelectionMask
Clip away the section of the mesh that is not selected in the SelectionMask.
CollectFields
Collect the fields that are fed into the module. The field will be added to the output field. The module has a buffer with a first in, first out behavior to keep a history of fields in the buffer.
GetDomainBoundary
This module will extract the inner and outer boundaries from a mesh. An inner boundary is defined as the boundary between different regions with a different value on the elements. The outer boundary is the boundary that surround the mesh.
GetFieldBoundary
A GetFieldBoundary version that works for all fields.
MergeFields
MergeFields glues any number of input fields into one output field.
MergeMeshes
MergeFields glues any number of input fields into one output field.
SplitAndMergeFieldByDomain
This module uses the data at the elements to split the mesh into segements that all have the same element data.
SplitFieldByConnectedRegion
This module splits a field into a series of fields in which every field contains a segment of the field that was not topologically connected to the other parts of the field.

DataArrayMath

AppendDataArrays
This module appends various data arrays together.
CalculateDataArray
This module computes a new scalar, vector or tensor array based upon a combination of scalars, vectors, and tensors.
CreateDataArray
This module computes a new scalar, vector or tensor array based upon a combination of scalars, vectors, and tensors.
CreateDataArrayFromIndices
This module takes the elements of the input array and reorders them according to order specified in the index vector.
CreateTensorArray
This module creates a N by 9 matrix describing tensors. The tensors are constructed out of two orthogonal N by 3 arrays describing the eigenvectors for the system and 3 column vectors describing the eigen values.
CreateVectorArray
This module creates a vector out of arrays of scalars.
DecomposeTensorArrayIntoEigenVectors
This module decomposes the a N by 9 Matrix, representing an array of tensors into three N by 3 matrices which contain the eigen vectors of the system, numbered from the most significant to the least significant and three column vectors representing the three eigen values of the tensor.
ReplicateDataArray
This module takes a ScalarArray, VectorArray or TensorArray and replicates it n-fold.
ReportDataArrayMeasure
This module calculates a measure of the array.
SplitVectorArrayInXYZ
Decomposed the vector in the three cartesian coordinates.

DataIO

ReadBundle
This module reads a bundle from disk.
ReadColorMap
The ColorMap Read a persistent colormap from a file on disk.
ReadColorMap2D
The ColorMap2 Read a persistent 2D colormap from a file on disk.
ReadField
ReadField allows the user to load-in any of the SCIRun supported Field types and then sends that Field to another module.
ReadMatrix
The ReadMatrix moudle reads a persistent matrix from a file and sends that matrix to another module.
ReadPath
The ReadPath module reads a persistent camera path from a file.
ReadString
This module reads a text file into a string.
WriteBundle
This module writes a bundle to disk.
WriteColorMap
Save persistent representation of a colormap to a file.
WriteColorMap2D
Save persistent representation of a colormap to a file.
WriteField
Saves persistent field objects received from upstream modules.
WriteMatrix
The WriteMatrix modules saves a persistent representation of a matrix to disk.
WritePath
The WritePath module saves persistent representation of a path to a file.
WriteString
This module writes a text file with the contents of the string.

DataStreaming

StreamMatrixFromDisk
Stream Data from a file on disk without loading the data into memory.

ExampleFields

GenerateSphericalSurface
This module creates an example spherical surface.

FieldProperty

GetMatrixFromFieldProperties
This module retrieves a matrix property from a field.
GetStringFromFieldProperties
This module retrieves a string property from a field.
InsertMatrixIntoFieldProperties
This module adds a 'matrix' object as a field property.
InsertStringIntoFieldProperties
This module adds a 'string' object as a field property.

FieldsData

ModalMapping
This module takes a source field and maps it onto a destiation field. The module projects the data onto the elements of the destination mesh.
SelectByFieldData
This module computes a new scalar, vector or tensor array based upon a combination of scalars, vectors, and tensors.
SelectByFieldsData
This module computes a new scalar, vector or tensor array based upon a combination of scalars, vectors, and tensors.

FiniteElements

BuildFEMatrix
This module builds the Finite Element Method stiffness matrix.
CreateFEDirichletBC
This module creates a Dirichlet boundary condition.
CreateLinkBetweenMeshAndCompGrid
This module computes how nodes should be merged over the boundary. It calculates the needed ordering in the computational grid.
CreateLinkBetweenMeshAndCompGridByDomain
This module computes how nodes should be merged over the boundary. It calculates the needed ordering in the computational grid.

Math

AppendMatrix
Append a matrix to a base matrix.
GetSubMatrix
Get a submatrix from a matrix by selecting row and column indices.
ReorderMatrixByCuthillMcKee
This module reorders the rows and columns of a square matrix according to the CutHill-McKee scheme in order to reduce the bandwidth of the matrix.
ReorderMatrixByReverseCuthillMcKee
This module reorders the rows and columns of a square matrix according to the reverse CutHill-McKee scheme in order to reduce the bandwidth of the matrix.
ReportMatrixColumnMeasure
Apply an operator on each column of the matrix.
ReportMatrixRowMeasure
Apply an operator on each row of the matrix.
ResizeMatrix
This module resizes a matrix.

ReportInfo

ReportDataArrayInfo
Get information on a matrix used as a ScalarArray, VectorArray, or TensorArray.
ReportFieldInfo
ReportFieldInfo is used to view the attributes of fields.
ReportMatrixInfo
ReportMatrixInfo is used to view the attributes of matrices.

Script

ManageParameterMatrix
This module gets a matrix from a ParameterList.
ManageParameterString
This module gets a String from a ParameterList.
ParameterList
This module allows for creation a bundle with strings, scalars, vectors, and tensors as components. Each component has a name and can be extracte out of the bundle.

SelectionMask

ConvertIndicesToSelectionMask
This function converts a list of indices into a SelectionMask. The module needs to know the length of the selection mask in order to know what the biggest index is. (This one is not necessarily selected)
ConvertSelectionMaskToIndices
This function converts the SelectionMask into a list of all activated elements.
DoSelctionMaskOR
Boolean OR operation on a series of selection masks.
DoSelctionMaskXOR
Exclusive OR operation on two selection masks.
DoSelectionMaskAND
Boolean AND operation on a series of selection masks.
DoSelectionMaskNOT
Inverts a selection. Nodes that were not selected get selection and nodes that were selected get deselected.

Time

ConvertTimeToWeightedIndices
This module calculates a weights vector to do a linear interpolation between two time frames.



Go back to Documentation:SCIRun:Reference