Polyflow Setup
Polyflow Setup
This container holds Setup data for an instance of Polyflow.
Methods
AddFile
Allows to import any kind of file into the Inputs sub-directory of the current Polyflow system
setup1.AddFile(FilePath="D:/temp/viscosity.crv") This command will copy the viscosity.crv file from the D:\temp directory into the Inputs directory of the current Polyflow system.
Required Arguments
- FilePath Input : Path of file to be added.
- Type string
Edit
Starts the editor (Polydata) given a Polyflow Setup Container
setup1.Edit() This command will launch the editor (Polydata) of the selected Setup cell.
Exit
Stops the editor (Polydata) or the solver (Polyflow) given a Polyflow Setup or Solution Container
setup1.Exit() This command will stop the editor (Polydata) of the selected Setup cell.
solver1.Exit() This command will stop the solver (Polyflow) of the selected Solution cell.
GetPolyflowMesh
Returns the PolyflowMesh object stored in the Polyflow Setup component.
-
Return
The PolyflowMesh object stored in the Polyflow Setup component. - Type DataReference
ImportMesh
Allows to import a mesh file (gambit *.neu file, *.poly file, *.msh Fluent Mesh file or Polyflow Mesh file). For *.neu and¨*.poly and a *.msh fluent file, a mesh conversion is automatically performed to get eventually a Polyflow Mesh file (*.msh)
setup1.ImportMesh(FilePath="D:/temp/swell.msh") This command will copy the swell.msh file from the D:\temp directory into the directory of the current Polyflow system.
Required Arguments
- FilePath Input : path of mesh file to be imported (*.neu, *.poly or *.msh)
- Type string
ImportSetup
Allows to import a setup file (*.dat file) into the current Polyflow system
setup1.ImportSetup(FilePath="D:/temp/swell.dat") This command will copy the swell.dat file from the D:/temp directory into the directory of the current Polyflow system.
Required Arguments
- FilePath Input : Path of Polyflow setup file to be imported.
- Type string
ImportUDF
Allows to import the udf file into the Inputs sub-directory of the current Polyflow system
setup1.ImportUDF(UdfFilePath="D:/temp/swell.udf") This command will copy the swell.udf file from the D:/temp directory into the Inputs directory of the current Polyflow system.
Required Arguments
- UdfFilePath Input : Path of Polyflow udf file to be imported
- Type string
SetMeshPreferences
Allows to specify which mesh of upstream polyflow system will be used in the current polyflow system : one does not provide a mesh file name, but a specific key to the corresponding mesh. The Mesh restart mode can take two values : "NoUpstreamMeshFile" or "SingleMeshFile"
setup1.SetMeshPreferences( meshRestartMode="SingleMeshFile", meshKey="mesh (t=0.5000000E+00)[formatted]")) This command will take the mesh generated by the upstream polyflow system at time t=0.5 (and that is formatted)
Note : the mesh keys can be found in the "last_result.pub" file generated by the Polyflow solver in the upstream system!
Required Arguments
- meshKey Mesh key (among the list of available meshes created by an upstream polyflow system)
- Type string
- meshRestartMode Mesh restart mode
- Type MeshRestartMode
StartFuseTool
Starts Polyfuse given a Polyflow Setup Container
setup1.StartFuseTool() This command will launch the mesh manipulation tool (Polyfuse) on the selected Setup cell.
StartMaterialsTool
Starts Polymat given a Polyflow Setup Container
setup1.StartMaterialsTool() This command will launch the material parameters fitting tool (Polymat) on the selected Setup cell.
StartPreferences
Starts the Editor of Polydata preferences given a Polyflow Setup Container or Starts the Editor of Polyflow preferences given a Polyflow Solution Container
This command applies to Setup and Solution cells. setup1.StartPreferences() This command will launch the Preferences setting tool (Polypref) of the selected Setup cell. solution1.StartPreferences() This command will launch the Preferences setting tool (Polypref) of the selected Solution cell.
Data Entities
PolydataPreference
Contains a reference to the preferences file for Polydata (setup editor). It is a provider of the preferences file.
Properties
DisplayText
The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.
- Type string
- Read Only No
PolyflowMesh
Contains a reference to a Polyflow mesh file. It is a provider for a Polyflow mesh file.
Properties
DisplayText
The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.
- Type string
- Read Only No
MeshReadingMode
Tells if one wants a conversion of the input mesh (*.poly or fluent *.msh) into a polyflow *.msh or if one wants a direct reading by polydata (when editing setup)
- Type MeshReading
- Read Only No
PolyflowSetup
Contains a reference to a Polyflow data file. It is a provider of the data file (containing the setup).
Properties
DisplayText
The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.
- Type string
- Read Only No