VMCalculator

VMCalc Home Online
Guide Home

Functions
  Array Functions
  VMFunctions

Display
  Overview
  Folder
  Peoperty Package
  Fluid
  Status and Halt

Menus
  File Menu
  Edit Menu
  Unit System Menu
  Help Menu

The available methods for accessing the VMCalculator from the basic code are:

VMAddCompoundAdd Compound to a property package
VMAddFluidAdd a fluid to a folder
VMAddFolderAdd a folder to a folder
VMAddGeneralCompoundAdd a hypothetical compound to a property package
VMAddPackageAdd a property package to a folder
VMAddSheetElementAdd a display element to a folder work sheet.
VMAppendSourceAppend source code to the end of the source for an object
VMAppendToFileAppend text to the end of a text file
VMAuthorizeComputerAuthorize the current computer to run VMGThermo
VMBinaryPairInformationGet information about binary pair coefficients in a property package
VMBinaryPairValueGet or set the value of a binary pair coefficient
VMCalculateExecute the code associated with an object
VMCloneGeneralCompoundMake a hypothetical using a database compound as its basis
VMCompoundCASNGet a compound's CASN
VMCompoundDoublePropertyGet a floating point property for a compound
VMCompoundFormulaGet a compound's chemical formula
VMCompoundIndexFromNameGet the position index of a compound installed in a property package
VMCompoundNameGet the name of a compound given the internal database index
VMCompoundNamesGet an array of the names of all the compounds available in the database
VMCompoundNamesFromCriteriaGet an array of names for compounds in the database that match certain criteria
VMCompoundStringPropertyGet a text property for a compound
VMCompoundSynonymGet a synonym for a compound
VMContextObjectGet the path of the currently selected object or set that object by assigning
VMConvertSetToSetConvert a value for variable type from one unit set to another
VMConvertSetToSetFromIdConvert a value for variable type from one unit set to another using numeric set ids
VMConvertSetToUnitConvert a value from the default unit for a unit set to a given unit
VMConvertUnitToSetConvert a value with a given unit to the default unit for a given set
VMConvertUnitToUnitConvert from one unit to another for a given unit type
VMCopyFluidCopy fluid properties to another or a new fluid
VMCopyPhaseCopy the properties of a phase for one fluid to the bulk properties of another
VMCurrentPackagesReturn a array of names of the property packages currently installed in the current foldler
VMCustomCommandAccess to the VMGThermo custom command
VMDeauthorizeComputerRemove the web key authorization for this computer
VMEditGeneralCompoundReplace the definition of a hypothetical compound
VMEnthalpyBasisGet or set the enthalpy basis
VMEnvelopeCalculate phase envelope behavior for a fluid.
VMExergyBasisGet or set the exergy basis
VMFileRead the contents of a text file into a string array
VMFlashPerform an equilibrium flash on a fluid
VMFlashSettingAssign flash setting for a Fluid
VMFlashTypeGet or set the type of flash a fluid performs
VMFluidGet or set fluid scalar properties
VMFluidGet or set fluid scalar properties
VMFluidArrayGet or set fluid array properties such as composition
VMFluidDisplayPropertiesGet or set the properties displayed for a fluid
VMFluidIsCalculatedDetermine if a fluid has been flashed since it was last changed
VMFluidNamesReturns the names of all the fluids in a folder as a string array
VMFluidPackageReturns the name of the property package used by a fluid
VMFluidSpecialPropertyReturns the result of a VMGThermo special property call for a fluid
VMFluidValReturns a cryptic fluid property including a type id - used in validations
VMHasFluidDetermines if a fluid exists at a given path
VMHasValueDetermines if VMValue exists at the given path
VMInteractionParameterMatrixNamesAllows property package to be queried about interaction parameter information
VMIsPropertyAnArrayDetermines if a property type is an array or scalar.
VMLibBuildReturn the VMGThermo build number
VMLibInfoReturns information about current version of VMGThermo
VMLibVersionReturn the VMGThermo build number
VMLiquidPhasesGet or set the number of liquid phases considered by a fluid
VMLiquidVolumeBasisGet or set the liquid volume basis
VMListDirectoriesList the directories in a given file system directory
VMListFilesList the files in a given file system directory
VMMembersList the members of a VMFolder
VMListFilesList the files in a given file system directory
VMMixFluidsMix multiple fluids or phases into a destination fluid.
VMListFilesList the files in a given file system directory
VMMoveCompoundMove a compound to a different position in the compound list
VMNameReturn the name of an object at a given path
VMNameGet the name of the object given its path.
VMNotesGet or set the notes for an object.
VMNumberOfPanesGet the number of panes for a given interaction parameter type
VMNumberOfSynonymsReturn the number of synonyms for a given compound
VMOilIssue command strings to the VMGThermo oil routine
VMObjectTypeReturn the type of an object.
VMOilCompositionAssign a fluid composition from an oil
VMOilStoreStringReturns a string that can be used to recreate the oil
VMOptimizePerforms an optimization of variables in a folder object.
VMPackageDefinitionGet the definition for a property package path
VMPackageDescriptionReturn the VMG description of a property package`
VMPackageNamesReturns a string array containing all of the property packages available in VMGThermo
VMPathReturns the full path to the object referenced
VMPhaseReturns a scalar property for a designated phase of a fluid
VMPhaseArrayReturns an array property (like composition) for a designated phase of a fluid
VMPhaseValReturns a cryptic phase property for a fluid including a type id - used in validations
VMPhysicalPropertyNameReturn the name of the physical property object being used for the calculation of a specific physical property
VMRaiseExceptionAn error has occurred - raise an exception
VMRecallOilThe passed string (from the VMOilStoreString call) is used to recreate an oil
VMRemoveRemoves the designated object
VMRemoveAllSheetElementsRemoves all of the display elements on the work sheet whose folder path is designated
VMRemoveCompoundRemoves the designated compound from a property package
VMRemoveSheetElementRemoves the designated work sheet display element
VMRemoveValueRemoves the designated VMValue from an object
VMRenameMemberRenames a member of a folder.
VMRenameValueRenames a value in an object
VMReplacePackageReplaces a property package with one with a new definition
VMResetAijChangedTells the property package to reset necessary properties because interaction parameters have changed
VMResetInteractionParametersThis method method resets all the binary interaction parameter matricies to their original values
VMRoutinesReturns a string array with the names of all calculator API routines along with the parameter types
VMSelectedCompoundCountGets the number of compounds installed in the property package
VMSelectedCompoundDoublePropertyGet floating point properties for a compound based on its installed position in the property package
VMSelectedCompoundNamesReturns a string array of the names of the compounds installed in a property package
VMSelectedCompoundStringPropertyGet a string property for a compound based on its installed position in the property package
VMSheetDrawCodeGets or sets the drawing code that can be used to create a background diagram on a worksheet.
VMSheetElementValueUsed to get or set the value of a work sheet display element property.
VMSolveNonlinearFinds the roots of one or more functions.
VMSourceAssigns basic source code to an object
VMStringGets or sets a string value associated with an object
VMStringsGets or sets a string array value associated with an object
VMUNIFACPairValueGet or set the value of a UNIFAC binary pair coefficient
VMUnitConstantReturns constants; e.g. gas constant, in a specified unit set
VMUnitNameForPropertyReturns the unit name in the current unit set for the property whose id is supplied
VMUnitNameForUnitTypeReturns the unit name in the current unit set for the unit type whose name is supplied
VMUnitSetGets or sets the current unit set
VMValueGets or sets a floating point value associated with an object
VMValuesGets or sets a floating point array value associated with an object
VMValueNamesReturns a string array containing the names of all the VMValues associated with an object
VMValueUnitTypeAssigns or returns the unit type associated with a folder value.