Version 9.3
Copyright 2008
Flow Science, Inc.
All rights reserved
FLOW-3D and TruVOF are registered
in the US Patent and Trademark Office.
CHAPTER 1: INTRODUCTION
1.1 FLOW-3D License Agreement
...1
1.2 Installation
...4
1.2.1 General Licensing Matters ... 4
1.2.2 Changing License Servers ... 7
1.2.3 New Installations of FLOW-3D ... 7
1.2.4 Upgrade Installation Instructions ... 13
1.2.5 Installing a New/Replacement License File ... 15
1.2.6 Licensing Portability ... 16
1.2.7 Uninstalling FLOW-3D ... 16
1.2.8 Special Notes for Users with SMP Parallel License Upgrade ... 17
1.3 Directory Structure and Environment Variables
...18
1.3.1 Environment Variables ... 18
1.3.2 FLOW-3D File Naming Convention ... 20
1.4 Hardware Requirements
...20
1.4.1
Supported
Operating Systems... 221.4.2 Minimum Hardware Requirements ... 22
CHAPTER 2: TUTORIAL 2.1 Tutorial Overview
...23
2.1.1 Philosophy for Using CFD ... 23
2.1.2 FLOW-3D Simulation Filenames ... 23
2.2 Running FLOW-3D
...25
2.2.1 Running FLOW-3D from the Graphical User Interface ... 25
2.2.2 Running FLOW-3D from the Command Line ... 32
2.3 Running an Example Problem
...38
2.3.1 Opening the Simulation File ... 38
2.3.2 Checking or Modifying the Problem Setup ... 39
2.3.3 Preprocessing ... 41
2.3.4 Diagnostic Files ... 44
2.3.5 Running the Solver ... 44
2.3.6 Postprocessing ... 46
CHAPTER 3: THEORY
3.1
Theory Overview ...57
3.2
Equations of Motion ...59
3.2.1 Coordinate Systems ... 59
3.2.2 Mass Continuity Equation and Its Variations ... 59
3.2.3 Momentum Equations ... 60
3.2.4 Fluid Interfaces and Free-Surfaces ... 64
3.3
Auxiliary Models ...70
3.3.1 Bubble and Void Region Models ... 70
3.3.2 Vaporization Residue ... 73
3.3.3 Buoyant Flow Model ... 73
3.3.4 Defect Tracking ... 74
3.3.5 Drift-Flux Model ... 74
3.3.6 Electric Field Model ... 77
3.3.7 Elastic and Thermoelastic Stress Model ... 81
3.3.8 Fan and Impeller Model ... 85
3.3.9 General Moving Object Model ... 86
3.3.10 Elastic Membrane and Elastic Wall ModelModel Model ... 93
3.3.11 Lost Foam Model ... 96
3.3.12 Porous Media Models... 97
3.3.13 Rigid Body Dynamics for Non-Inertial Reference Frame ... 104
3.3.14 Sand Core Blowing Model ... 106
3.3.15 Sediment Scour Model ... 106
3.3.16 Shallow Water Model... 107
3.3.17 Solidification Shrinkage and Porosity Models ... 109
3.3.18 Turbulence Models ... 110
3.3.19 Wall Heat Transfer ... 115
3.4
Numerical Approximations ...120
3.4.1 Overview ... 120
3.4.2 Notation ... 120
3.4.3 Pressure Solution Algorithm ... 137
3.4.4 Scalar Advection ... 142
3.4.5 Diffusion Process, Heat Conduction and Heat Transfer ... 146
3.4.6 Boundary Conditions... 150
3.4.7 Stability Considerations ... 160
3.4.8 Discrete Particle Dynamics ... 162
3.4.9 Rigid Body Dynamics Algorithm for Non-Inertial Reference Frame Model ... 165
3.4.10 Rapid Shrinkage Algorithm ... 169
3.4.11 Reactive Flows Algorithm ... 170
3.5
References ...172
CHAPTER 4: USER INTERFACE 4.1 Overview
...175
4.2 Main Menu...176
4.2.1 File Menu ... 176 4.2.2 Diagnostics Menu ... 182 4.2.3 Preference Menu ... 183 4.2.4 Utilities Menu ... 184 4.2.5 Simulate Menu ... 188 4.2.6 Help Menu ... 189 4.3 Navigator...190
4.4 Model Setup...192
4.4.1 General Tab ... 192
4.4.2 Physics .. ... 196
4.4.3 Fluids.. ... 199
4.4.4 Meshing & Geometry ... 201
4.4.5 Boundaries ... 229 4.4.6 Initial.. ... 232 4.4.7 Output.. ... 234 4.4.8 Numerics ... 237 4.5 Simulate Tab
...239
4.6 Analyze Tab...243
4.6.1 Custom Plots ... 247 4.6.2 Probe Data ... 248 4.6.3 One-Dimensional Plots ... 250 4.6.4 Two-Dimensional Plots ... 251 4.6.5 Three-Dimensional Plots ... 254 4.6.6 Text Output ... 257 4.6.7 Neutral File ... 259 4.7 Display Tab...260
4.7.1 2-D Format Display Mode ... 260
4.7.2 3-D Format Display Mode ... 266
CHAPTER 5: MESHING AND GEOMETRY
5.1
Constructing Geometry ...281
5.1.1 Geometry Methods in FLOW-3D ... 281
5.1.2 Constructing Geometry Using the GUI ... 286
5.1.3 Constructing Geometry Using the Text Editor ... 301
5.2
Mesh Building...305
5.2.1 Meshing Basics ... 305
5.2.2 Mesh Building Mechanics ... 307
5.3
Reviewing the FAVORized Geometry and Mesh ...318
CHAPTER 6: MODEL REFERENCE 6.1 Overview
...325
6.1.1 How Do I Model...? ... 325
6.1.2 What are the Available Numerical Options for...? ... 453
CHAPTER 7: POSTPROCESSING 7.1 Post Processing Overview
...467
7.1.1 Accessing FLOW-3D Results Files ... 467
7.2 How to Perform Common Tasks
...470
7.2.3 Changing the 2-D Display Onscreen View ... 473
7.3 Data Output
...475
7.3.1 Available Options for Data Output ... 475
7.3.2 Exporting Neutral File Data ... 478
7.3.3 Generating Text Output ... 480
7.3.4 Customizing Plots Using the FLSINP File... 480
7.4 Post Processor Input Data
...484
7.4.1 Namelist $contrl ... 484
7.4.2 Namelist $pltreq Variables ADVFRM - BVAL2 ... 486
7.4.3 Namelist $pltreq Variables CLRTPS - DRWFRM ... 487
7.4.4 Namelist $pltreq Variables IBINRY - IFRHID ... 488
7.4.5 Namelist $pltreq Variables IHIDE - ITMGRP ... 489
7.4.6 Namelist $pltreq Variable ITRANS ... 489
7.4.7 Namelist $pltreq Variables IVARN - IVRNP5 ... 494
7.4.8 Namelist $pltreq Variables IX - JMIN ... 494
7.4.9 Namelist $pltreq Variable KOPPLT ... 496
7.4.10 Namelist $pltreq Variables LBAXIS - NYLAB ... 498
7.4.11 Namelist $pltreq Variables OMODE - PVNAM5 ... 498
7.4.12 Namelist $pltreq Variables QMN - TMIN ... 500
7.4.13 Namelist $pltreq Variables VARMIN - VSCALE ... 501
7.4.14 Namelist $pltreq Variables XSHRNK - YMAG ... 502
CHAPTER 8: RESTARTS
8.1
Performing Restarts...503
8.2
Restart Options ...507
8.2.1 Fluid Distribution ... 507
8.2.2 Grid Overlay (GO) ... 507
8.2.3 Heat Transfer, Scalar Transport, Turbulence and Particles ... 508
8.2.4 Non-Inertial Reference Frames ... 508
CHAPTER 9: CUSTOMIZATION
9.1
General Customization Information ...509
9.1.1 File Structure ... 509
9.1.2 Include Statements ... 510
9.1.3 Subroutines Included in Distribution ... 510
9.1.4 Important Variables ... 514
9.1.5 Important Comdeck Files ... 517
9.1.6 Dummy Variables ... 517
9.1.7 User Definable Namelist USRDAT ... 517
9.1.8 Sample Customizations ... 518
9.1.9 Adding New Models at the End of a Time Cycle ... 521
9.2
Requirements for Customizing on Windows ...523
9.2.1 Requirements for 32-bit Windows ... 523
9.2.3 Adding New Source Files ... 524
9.3
Customizing on Linux Platforms ...525
CHAPTER 10: INPUT VARIABLE SUMMARY
10.1
Input File Specifications ...527
10.1.1 Input File Structure and Namelist Blocks ... 527
10.2
Physical and Computational Parameters (XPUT) ...530
10.2.1 Advection Options... 530
10.2.2 Collision Model Options ... 531
10.2.3 Convergence Criteria Options ... 532
10.2.4 Drag Coefficients and Options ... 533
10.2.5 Energy and Heat Transfer Options ... 534
10.2.6 Explicit/Implicit Options ... 535
10.2.7 File Control Options ... 536
10.2.8 Flow Mode Options ... 537
10.2.9 Gravity and Non-Inertial Reference Frame Options ... 537
10.2.10 Initialization and Restart Options ... 538
10.2.11 Mass Source Options ... 540
10.2.12 Numerical Options ... 541
10.2.13 Physical Model Options ... 542
10.2.14 Plot Output Control ... 548
10.2.15 Pressure Iteration Options ... 549
10.2.16 Print Output Control ... 550
10.2.17 Termination Control ... 551
10.2.18 Thermal Cycling Options ... 551
10.2.19 Time-Step Control ... 552
10.2.20 Turbulence and Viscous Options ... 553
10.2.21 Turbulence Equation Coefficients and Diffusion Parameters ... 554
10.2.22 User Defined Variables ... 555
10.2.23 Void Heat Transfer Coefficients ... 556
10.3
Computational and Print Limits (LIMITS) ...556
10.3.1 Computational Limits Namelist (LIMITS) ... 557
10.3.2 Print Limits ... 558
10.4
Fluid Namelist (PROPS)...559
10.4.1 Cavitation Properties ... 559
10.4.2 Density Properties ... 559
10.4.3 Electrostatic Properties ... 560
10.4.4 Drift Flux Properties... 560
10.4.5 Elastic and Plastic Properties ... 561
10.4.6 Fluid Names and Units Identifiers ... 562
10.4.7 Phase Change Properties ... 562
10.4.8 Segregation Model Parameters ... 563
10.4.9 Solidification Properties ... 564
10.4.12 Thermal Properties ... 566
10.4.13 Viscous Properties ... 567
10.4.14 Wall Shear Properties ... 568
10.5
Scalar Transport Namelist (SCALAR) ...569
10.5.1 General and Scalar Advection Parameters ... 569
10.5.2 Scalar Density and Viscosity Parameters ... 570
10.5.3 Scalar Electrostatics, Electro-osmosis and Electromechanics Parameters ... 570
10.5.4 Defect Tracking Parameters for Lost Foam and Free Surfaces ... 571
10.5.5 Air Entrainment at Free Surfaces Parameters ... 572
10.5.6 Micro-porosity Model Parameters... 573
10.5.7 Cell Filling Time Parameters ... 573
10.5.8 Rate of Mass Evaporating/Condensing ... 574
10.5.9 Sand Core Blowing Parameters ... 574
10.5.10 Cavitation Potential Parameters ... 574
10.5.11 Binary Alloy Segregation Parameters ... 574
10.5.12 Fluid Residence Time Parameters ... 575
10.6
Scalar Sediment Scour Parameters ...577
10.7
Chemistry Namelist (CHM) ...578
10.7.1 Chemistry Parameters ... 578
10.8
Capillary Namelist (PCAP) ...579
10.8.1 Capillary Pressure (PCAP) ... 579
10.9
Rigid Body Namelist (RBDATA) ...580
10.9.1 Rigid Body Dynamics Numerical Options ... 580
10.9.2 Rigid Body Dynamics Initial Conditions ... 580
10.9.3 Rigid Body Dynamics Properties ... 583
10.10 Boundary Condition Namelist (BCDATA) ...584
10.10.1 Boundary Condition Type and Time Table ... 584
10.10.2 Boundary External Potential ... 585
10.10.3 Boundary Fluid Fraction ... 588
10.10.4 Boundary Fluid Density ... 589
10.10.5 Boundary Pressure... 589
10.10.6 Boundary Scalar Concentration ... 591
10.10.7 Boundary Temperature and Wall Power ... 592
10.10.8 Boundary Thermal Properties and Heat Transfer Coefficients ... 594
Mesh Namelist (MESH) ...600
10.10.12 Mesh Generator (MESH) ... 600
10.11 Component Setup (OBS) ...602
10.11.1 Component: General Parameters ... 602
10.11.2 Subcomponents: General Parameters ... 603
10.11.3 Subcomponents: Limiters ... 604
10.11.4 Subcomponents: Function Coefficients... 605
10.11.5 Subcomponents: Transformations ... 606
10.11.6 Component Copy: Parameters ... 607
10.11.8 Component Properties: Electrostatic and Electroosmotic Potential, Joule Heating ... 609
10.11.9 Component Properties: Heat Transfer Coefficients ... 609
10.11.10 Component Properties: Lost Foam Casting Model Parameters ... 611
10.11.11 Component Properties: Mass Sources ... 612
10.11.12 Component Properties: Moisture Content ... 613
10.11.13 Component Properties: General Moving Objects (GMO) ... 613
10.11.14 Component Properties: Simple Moving Objects ... 619
10.11.15 Component Properties: Porous Components ... 621
10.11.16 Component Properties: Temperature and Power ... 625
10.11.17 Component Properties: Thermal and Heat Transfer ... 626
10.12 Initial Fluid Conditions (FL)...628
10.12.1 Initial Conditions: Uniform ... 628
10.12.2 Initial Conditions: General Region Parameters ... 630
10.12.3 Initial Conditions: Region Values ... 630
10.12.4 Initial Conditions: Region Limiters ... 632
10.12.5 Initial Conditions: Region Function Coefficients ... 633
10.12.6 Initial Conditions: Region Transformations ... 634
10.12.7 Initial Conditions: Pointers ... 634
10.12.8 Initial Conditions: Valves ... 635
10.13 Baffle Setup (BF) ...636
10.13.1 Baffle Namelist (BF) ... 638
10.13.2 Baffle Regions: Baffle Location... 639
10.13.3 Baffle Regions: Function Coefficients ... 640
10.13.4 Baffle Regions: General Parameters ... 640
10.13.5 Baffle Regions: Limiters ... 641
10.13.6 Baffle Regions: Transformations ... 642
10.13.7 Baffles: General Parameters ... 643
10.14 Initial Fluid and Solid Temperature Setup (TEMP) ...644
10.14.1 Temperature: Uniform Initial Conditions ... 644
10.14.2 Temperature Regions: Settings ... 644
10.14.3 Temperature Regions: Limiters ... 645
10.14.4 Temperature Regions: Function Coefficients ... 646
10.14.5 Temperature Regions: Transformations ... 647
10.15 Non-Inertial Reference Frame (MOTN) ...648
10.15.1 Non-Inertial Reference Frame: General Parameters ... 648
10.15.2 Non-Inertial Reference Frame: Simple Spin and Shake Model ... 649
10.15.3 Non-Inertial Reference Frame: Gravity Field ... 649
10.15.4 Non-Inertial Reference Frame: Sinusoidal 6 Degree-of-Freedom Model ... 650
10.15.5 Non-Inertial Reference Frame: Tabular Data ... 651
10.15.6 Non-Inertial Reference Frame: Rigid Body Control Forces ... 651
10.16 Graphic Output (GRAFIC) ...653
10.16.1 Graphic Output: Default Color Flag and Symmetry Reflections ... 653
10.16.2 Graphic Output: Selected Data ... 654
10.16.3 Graphic Output: Contour Plots ... 656
10.16.6 Graphic Output: History Probes ... 662
10.16.7 Graphic Output: Iso-Surface Plots ... 664
10.16.8 Graphic Output: Particle Plots ... 667
10.16.9 Graphic Output: Pre-processor Geometry Plots ... 670
10.16.10 Graphic Output: Solidification Criterion Functions ... 671
10.16.12 Graphic Output: Viewpoint Specification ... 676
10.17 Particle Setup (PARTS) ...677
10.17.1 Particle Setup: General Particle Data ... 677
10.17.2 Particle Setup: Block Initialized Particles ... 678
10.17.3 Particle Setup: Source Initialized Particles ... 679
10.17.4 Particle Setup: History Point Particles ... 681
10.17.5 Particle Setup: Flux Surface and Force Window Data ... 681
10.17.6 Particle Setup: Mass/Momentum Sources ... 682
10.18 User Defined Namelist (USRDAT) ...684
CHAPTER 11: UNITS AND CONVERSIONS FACTORS
11.1
Overview ...685
11.2
Units and Conversion Factors...686
11.2.1 Acceleration Units ... 686
11.2.2 Angle Units ... 686
11.2.3 Angular Velocity Units ... 687
11.2.4 Area Units ... 688
11.2.5 Density Units ... 688
11.2.6 Electric Charge Units ... 689
11.2.7 Electric Potential Units ... 689
11.2.8 Energy Per Unit Volume Units ... 690
11.2.9 Energy Units ... 690
11.2.10 Force Units ... 690
11.2.11 Friction Coefficient Units ... 691
11.2.12 Heat Flux Units ... 691
11.2.13 Heat Transfer Coefficient Units ... 691
11.2.14 Length or Position Units ... 692
11.2.15 Mass Flow Rate Units ... 693
11.2.16 Mass Source Per Unit Area Units ... 693
11.2.17 Mass Source Per Unit Volume Units ... 694
11.2.18 Mass Units ... 694
11.2.19 Momentum or Force Impulse Units ... 694
11.2.20 Power Per Unit Mass Units ... 694
11.2.21 Power Units ... 695
11.2.22 Pressure Units ... 695
11.2.23 Radiation Heat Transfer Coefficient Units ... 696
11.2.24 Rate Units ... 696
11.2.25 Reciprocal Length Units ... 697
11.2.26 Specific Energy Dissipation Rate Units ... 697
11.2.27 Specific Energy Units... 698
11.2.29 Speed Units ... 699
11.2.30 Surface Tension Coefficient Units ... 699
11.2.31 Temperature Units ... 700
11.2.32 Temperature-Dependent Surface Tension Coefficient Units ... 701
11.2.33 Thermal Capacity per Unit Volume Units ... 701
11.2.34 Thermal Capacity Units ... 702
11.2.35 Thermal Conductivity Units ... 702
11.2.36 Time Units ... 703
11.2.37 Valve Coefficient Units ... 703
11.2.38 Viscosity Units ... 704
11.2.39 Volume Flow Rate Units ... 705
11.2.40 Volume Units ... 705
11.3
Units Summary...706
CHAPTER 12: DIAGNOSTICS12.1
Diagnostic Messages...709
12.1.1 The Mentor ... 709 12.1.2 Preprocessor Messages ... 709 12.1.3 Solver Messages ... 710 12.1.4 Common Problems ... 715 CHAPTER13: GLOSSARY ...717
1.1
FLOW-3D License Agreement ...1
1.2
Installation ...4
1.2.1 General Licensing Matters ... 4
License Technology and Terms ... 4
Floating vs. Node-Locked Licenses ... 5
FLEXlm License Administration Tools ... 6
1.2.2 Changing License Servers ... 7
1.2.3 New Installations of FLOW-3D ... 7
New Installations on Windows Operating Systems ... 7
New Linux Installations ... 11
1.2.4 Upgrade Installation Instructions ... 13
Windows XP/Vista ... 13
Linux Installations ... 14
1.2.5 Installing a New/Replacement License File ... 15
1.2.6 Licensing Portability ... 16
1.2.7 Uninstalling FLOW-3D ... 16
1.2.8 Special Notes for Users with SMP Parallel License Upgrade ... 17
1.3
Directory Structure and Environment Variables ...18
1.3.1 Environment Variables ... 18
1.3.2 FLOW-3D File Naming Convention ... 20
1.4
Hardware Requirements ...20
1.4.1
Supported
Operating Systems... 221.1
FLOW-3D LICENSE AGREEMENT
This End-User License Agreement (the “Agreement”) is between You and Flow Science, Inc., a New Mexico corporation ("Licensor"). This Agreement authorizes You, on a nonexclusive and nontransferable basis, to use a copy of FLOW-3D (the "Code") and related documentation subject to the terms and conditions set out in this Agreement. By installing the Code, you are signifying Your agreement to the terms of this Agreement. 1. The Code is licensed to You on the basis of commercial terms specified in an agreement between
Licensor and You (or the entity that has authorized Your use of FLOW-3D for your work, research or study). Said agreement governs such terms as number of licenses for the FLOW-3D solver, price, license term, right to technical support and upgrades, and so on. IF YOU ARE AN ACADEMIC USER, YOU AGREE TO RESTRICT YOUR USE OF THE CODE STRICTLY TO TEACHING, TO ACADEMIC AND/OR UNSPONSORED RESEARCH, OR TO SPONSORED RESEARCH THAT CAN AND WILL BE FREELY PUBLISHED WITH NO PROPRIETARY RESTRICTIONS.
2. In connection with the License granted herein, Licensor shall license to You a user authorization device, such as a hardware key or a license file (hereinafter referred to as "Key"), to be shared by all processors that can access the Code on Your network. You agree that the number of simultaneous simulations using the Code’s solver module shall not exceed the number of Keys licensed to You in accordance with the
FLOW-3D Purchase Agreement. Title to each Key will remain with Licensor, and You shall assist
Licensor in reclaiming such Keys in the event of Your breach of this Agreement. If Your copy of the Code must be replaced for any reason, except for the replacement of defective media or software errors, there shall be a replacement fee not to exceed $500.00. If a Key is lost, Licensor will provide a replacement Key at Licensor’s then current fee for a replacement Key. Additional Keys may be provided to You at Licensor’s then current fees.
3. If arrangements for technical support have been made, only a person designated as a “Registered User”, or persons who have attended a FLOW-3D Training Class, will be entitled to contact Licensor to seek technical support. Licensor may provide technical support via telephone, e-mail, fax, and/or mail to You during the License period.
4. If You are an academic user, technical support is limited to the following: (a) Licensor will provide User with software upgrades when they become available; (b) Licensor will assist in installation of the code and will answer questions about how to use the input variables to implement the various models in the Code; (c) at its option, Licensor will analyze results that appear obviously incorrect because they don’t seem to reproduce simple analytical results or expected conservation laws; (d) Licensor will also provide access to a number of subroutines to allow users to implement small changes to the Code, including boundary conditions and material properties; (e) Licensor will not assist in the making of revisions or customizations to the Code.
5. This Code, FLOW-3D, and its documentation are the property of Flow Science, Inc. You recognize that the Code is subject to the copyright laws of the United States of America and embodies technology, methods, algorithms, trade secrets, trademarks, and service marks that are proprietary to the Licensor. No title to or ownership of the Code or any part thereof is hereby transferred to You. You acknowledge that, by virtue of this Agreement, You acquire only the right to use the Code pursuant to the terms of this Agreement. You agree to take all necessary action to protect the confidential and proprietary information in the Code, including appropriate instruction and agreement with its employees, to avoid the disclosure of the contents of the Code to any other person, firm, or corporation, and to treat the Code with the same degree of care that it provides its own confidential information. Due credit must accompany presentation of Your calculated results.
one archival copy for backup purposes), but You may reproduce related documentation; or (iii) shall not decompile, disassemble, or otherwise reverse engineer the Code. Use, duplication, or disclosure of the Code is restricted under the conditions of this Agreement and/or the provisions of FAR 52.227 and DFARS 252.227-7013, as may be amended or superseded.
7. No sublicensing, assignments of rights or interest, or delegation of duties under this agreement shall be made or become effective without the prior written consent of Licensor. This prohibition of sublicensing, assignment, and delegation extends to all sublicensing, assignments and delegations that may be lawfully prohibited by this Agreement. Any attempt at sublicensing, assignment, or delegation without the prior written consent of Licensor shall be wholly void and ineffective for all purposes.
8. At the termination of the license, You will return or destroy all copies of the Code, in any form, in its possession. If You elect to destroy all copies of the Code, You shall provide Licensor with a certificate attesting to the destruction.
9. The Licensor warrants that it has the right to grant to You a license and warrants that the Code does not infringe third party intellectual property rights. Licensor shall indemnify and hold You harmless from and against any claim of infringement of a United States patent or copyright based upon the Code, provided You gives Licensor prompt notice of and the opportunity to defend any such claim. Licensor shall have the right to settle such claim or, at Licensor’s option, provide You: (i) a paid-up license; (ii) substitute functionally equivalent software; or (iii) a refund of a pro rata portion of the license fee paid for the Code. 10. The warranty and the obligation and liability of Licensor expressed in the Agreement are in lieu of, and
YOU HEREBY WAIVE, ALL OTHER GUARANTEES AND WARRANTIES OR OBLIGATIONS AND LIABILITIES OF LICENSOR HEREUNDER, EXPRESSED OR IMPLIED, ARISING BY LAW OR OTHERWISE, INCLUDING WITHOUT LIMITATION ANY IMPLIED WARRANTY OF FITNESS FOR A PARTICULAR PURPOSE OR MERCHANTABILITY AND ALL OBLIGATIONS AND LIABILITIES WITH RESPECT TO USE OF THE CODE OR USE OF RESULTS AND DATA DERIVED FROM SUCH USE, LOSS OF USE, DATA, REVENUE, OR PROFIT, OR INDIRECT, SPECIAL, PUNITIVE, OR CONSEQUENTIAL DAMAGES. You agree that the obligations of Licensor as set forth herein shall constitute the sole remedy for a claim relating in any way to the Code provided under this Agreement. The liability of Licensor shall in all cases be limited to the purchase price of the Code.
11. The parties’ exercise of, or failure to exercise, any right, remedy, or privilege under this Agreement will not constitute a waiver of any rights of that party under this Agreement.
12. A determination that any provision of this Agreement is invalid, illegal, or unenforceable shall not affect the enforceability of any other provision.
13. This Agreement shall terminate immediately upon Your failure to conform to any term, condition, or restriction of this Agreement; and Licensor shall have the immediate right, without notice, to repossess the Code, any copies thereof and all related documentation. All sums paid pursuant to the Agreement shall be retained by Licensor as liquidated damages as damages cannot be reasonably ascertained. In addition, Licensor shall have all other remedies and damages available to it in law or equity. Licensor is entitled to reimbursement from You for any expenses, legal fees, and/or court costs incurred in the enforcement of its rights hereunder or in the collection of damages.
14. Licensor reserves the right, without limitation, and without obtaining prior approval from or notice to You, to make changes in and to the Code.
15. This Agreement shall be governed by and construed in accordance with the laws of the United States and the State of New Mexico, as applied to agreements entered into and to be performed entirely within New Mexico between New Mexico residents without reference to conflict of laws. This Agreement and the performance of the Parties required hereunder shall not be governed by or otherwise subject to the United Nations Convention for the International Sale of Goods. Any civil suit or proceeding relating to this agreement shall be brought only in U.S. Federal District Court or State District Court within the State of
New Mexico, and each of the Parties consent to the personal jurisdiction and venue of such courts. Judgment upon any award made in such proceeding may be entered and enforced in any court of competent jurisdiction.
16. Licensor shall not be liable or in default under this Agreement for failing to perform if such failure results from acts of God or other reasonable causes beyond the control of Licensor.
17. Absent Licensor’s express written acceptance thereof, terms and conditions contained in any purchase order or other communication—whether oral or written—issued by You for the Code, other than the quantity or classification of the Code ordered, shall not be binding on Licensor to the extent that such terms and conditions are additional to or inconsistent with those contained in this Agreement. Any modifications to this Agreement must be in writing and signed by authorized representatives of both parties. In the event of any conflict between the terms stated herein and the terms of a written, executed License Agreement between You and Licensor, the terms of the written, executed License Agreement shall prevail.
1.2 INSTALLATION
Detailed information on new installations of FLOW-3D is given below in 23HNew Installations of FLOW-3D. Help with upgrade installations for FLOW-3D is given below in 24HUpgrade Installations of FLOW-3D. Instructions for installing a new or replacement license file is contained in 25HInstalling a New/Replacement
License File.
1.2.1 General Licensing Matters
License Technology and Terms
FLOW-3D uses the licensing package FLEXlm, by Acresso Software. FLEXlm enables FLOW-3D licenses
to be shared across a network. More information about FLEXlm and its tools can be found below under
26H
FLEXlm License Administration Tools. A FLEXlm end-user manual is available in the “utilities”
subdirectory of theinstallation. Flow Science will provide you with a FLOW-3D license file, named flow3d.lic.
License Files and Servers
A valid license file from Flow Science is required to use FLOW-3D. This license file will be sent to you as an email attachment from [email protected], Flow Science’s License Administrator. As described in later portions of these instructions, this license file must be saved in a FLOW-3D directory on a computer you choose to be your "license server."
FLOW-3D can be used on multiple computers on your network. However, one computer must be selected to
be the license server. If the computer you choose to be the license server will not actually be used to run
FLOW-3D, then only the FLEXlm license server needs to be installed on it.
If you plan to install the FLEXlm license server on a Windows computer, a dongle that attaches to the parallel or USB port of your computer will be provided by Flow Science. This key should have been enclosed in your
FLOW-3D package.
Tokens
The total number of FLOW-3D solver processes that you can run concurrently is determined by the number of "tokens" contained in your license file. The number of tokens available depends on how many were purchased. The license server checks tokens out to client computers on your network, and then checks them back in when the application has completed. In this process, tokens are counted by the license server and when the total number of tokens that you have purchased has been reached, no more tokens can be checked out until a used token is checked back in.
There are essentially an unlimited number of tokens available to run FLOW-3D’s auxiliary programs such as the preprocessor, the postprocessor, and the various visualization options.
There are several different types of solver tokens. The most important distinction is between "serial" solver tokens and "parallel" solver tokens. Flow Science offers multi-processor versions of FLOW-3D for both shared-memory (SMP) and distributed-memory (cluster) environments. A shared memory parallel solver token (shown in your license file as “hydr3dp”) enables you to run FLOW-3D simulations using more than one processor on a multiprocessor computer. For the distributed-memory version (FLOW-3D/MP), a hydr3d or hydr3dp instance token is required as well as hydr3dmpi rank tokens. For example, to run a simulation on 16 processors using FLOW-3D/MP, the license file must have a hydr3d or hydr3dp token and 15 hydr3dmpi tokens.
Unless you have purchased tokens for one of the multi-processor versions, your license file will contain one or more serial solver tokens (“hydr3d”). These serial solver tokens can be used on either single-processor or multiple-processor computers running any supported operating system.
Definition of Client and License Server
Any computer running FLOW-3D is referred to as a “client.” The computer on which the FLEXlm license server is installed will be referred to as the “license server.” A computer that runs both FLOW-3D and the license server is called a “client/server.”
“Software Package” and “Software Distribution”
The terms “software package” and “software distribution” will be used to refer to the directory structure containing all of the data files and executables needed to run FLOW-3D on a particular computer.
Floating vs. Node-Locked Licenses
There are two general types of licenses used to enable FLOW-3D: "floating" and "node-locked." A floating license is the most common type of license and is available to any computer on your network. You can also ask for your license to be a node-locked license. Node-locked licenses can only be used on the designated computer.
Both floating and node-locked licensing schemes require that one computer be designated as the license server.
Floating Licenses
To utilize floating licenses, it is important that both the computer you intend to use as your license server and your network are reliable. The TCP/IP protocol must be loaded and functional, and all intended clients must be able to access the license server. Floating licenses may also be accessed through a VPN tunnel.
The computer that is acting as your license server may be any computer on your network, and that computer does not need to have FLOW-3D installed on it. The license server may be a Windows or a Linux computer. You may load FLOW-3D on any client with a supported Linux or Windows computer on your network. A hardware key is not needed on a client computer unless it utilizes a node-locked license.
Running FLOW-3D on a stand-alone computer
To employ a floating license on a single computer, select the client/server option. Running FLOW-3D over a network
The license server and the clients may reside on the same local area network, over a WAN, or across VPN.
Node-Locked Licenses
Users may choose to have their solver tokens locked to a particular computer so that only that computer can run the solver.
Advantages and Disadvantages
Both floating and node-locked licensing schemes have their advantages and disadvantages. A floating license is advised if several people are sharing a license, or if you want to be able to run FLOW-3D on a different computer if a particular computer is busy. With a floating license, you can also setup a problem on one computer while using another to run the FLOW-3D solver on a second problem. Of course, if others are using all available tokens, the solver won't run until a token becomes available. The main advantage of a node-locked license is the ability to insure that your token(s) are always available to you and not available to others on your network.
Note: All licenses are floating licenses unless specifically requested as node-locked.
FLEXlm License Administration Tools
Acresso Software provides utilities for you (or your license administrator) to help manage FLEXlmlicensing activities. A FLEXlm End User Manual is available in the "utilities" subdirectory of the distribution. This manual is available in both PDF and HTML format. The PDF file can be read using Adobe Acrobat. For Windows computers, a program (lmtools.exe) is provided with all installations. With LMTOOLS, you can start, stop and configure FLEXlm license servers, get system information, get server information, and more. For more information, see Section 7.16 of FLEXlm End User Manual.
On Windows computers, the license manager daemon (lmgrd) will restart automatically whenever the computer is rebooted. On Linux computers, however, you will have to start the license manager each time the computer is rebooted. To have the license manager start automatically on Linux requires editing the appropriate boot script and inserting the appropriate startup commands. See Section 6.2 of the FLEXlm End User Manual for more information.
A summary of commonly used administration tools on Linux is included here. Full descriptions of these and other available utilities can be found in Chapter 7 of the FLEXlm manual.
lmdiag – diagnoses license checkout problems.
(Useful debugging command: lmutil lmdiag –n –c full_license_file_path )
lmdown – gracefully shuts down all license daemons on the license server node. lmgrd – the main daemon program for FLEXlm.
lmhostid – reports the hostid of a system.
lmreread – causes the license daemon to reread the license file and start any new vendor daemons. lmstat – helps you monitor the status of all network licensing activities.
(Useful debugging command: lmutil lmstat -a -c full_license_file_path )
lmver – reports the FLEXlm version of a library or binary file.
Note: It is not recommended to use "kill –9" to shut down the license server on Linux computers. Either use "lmdown" or use the "kill" command without the "-9" parameter.
1.2.2 Moving License Servers
When a floating license is locked to a fixed host ID, such as an Ethernet address or host ID, it is recommended that users choose a server which is likely to be used for the duration of the license. Changing fixed host IDs during your license term may incur a re-licensing fee. Re-licensing fees are not necessary (maximum one year) when users utilize a USB or parallel port hardware key (dongle) as their host ID. To move the dongle (and hence license server) to a different computer, the user simply needs to change the first line in their license file to reflect the computer name change. For example, if the license server was previously running on a server named Celsius and you wish to move it to Kelvin, you would change the first line in the license file from:
SERVER Celsius FLEXID= “your ID” to
SERVER Kelvin FLEXID= “your ID”
1.2.3 New Installations of
FLOW-3D
New Installations on Windows Operating Systems
Note: You must have Administrator privileges to install FLOW-3D under Windows XP/Vista. Before installing FLOW-3D, you should close all other programs that might be running on your computer.
Step One -- The installation of FLOW-3D on a computer running Windows is a relatively automated process. If Autorun is enabled on your CD-ROM drive, the installation should begin when the CD is inserted. If Autorun is not enabled or if, for some reason, the installation process does not begin on its own, simply run the setup.exe program in the root directory of the CD. This can be done by either running it from the Run command under the Start button or by double-clicking on setup.exe in Windows Explorer.
Step Two -- The first dialog you will see is the Welcome dialog. Click Next to move to the next step.
Step Three -- The next dialog is the FLOW-3D License Agreement. Please read it carefully. If you agree to all the terms, click the Next button to signify your agreement and move to the next dialog.
Step Four -- The next dialog is the User Information dialog Enter your name and the company name here, and then click Next to move to the next step.
Step Five -- On the next dialog, choose a destination location for FLOW-3D on your computer. The default location for FLOW-3D is c:\flow3d\”version” where “version” represents the version being installed. If a license server is currently running in the selected installation directory, a dialog will appear which will assist you in terminating this license server easily. If the license server is not terminated, a reboot will be required to complete the installation.
Option 1 -- "Client/Server" -- Choose the first option if you intend to run FLOW-3D on this computer and you want this computer to control your FLOW-3D licenses (that is, act as the license server) for use on other computers across a network. This situation is reflected below:
Be sure to copy your FLOW-3D license file (flow3d.lic) to your “licenses” directory once installation is complete. Your computer will be acting as a license server, and can issue tokens to any FLOW-3D clients on the network.
Note: Choose the server for your FLOW-3D environment carefully. The license server requires a stable computer. Moving the FLOW-3D license to a new computer before your license period expires may entail a re-licensing fee.
Option 2 – “Client (FLOW-3D)” -- Choose this option if you intend to only run FLOW-3D on your computer, and the computer is not going be used as the license server (i.e., this computer is a client only and another computer is the license server). Be sure to copy the license file from the server to your licenses directory and also make sure the server name for your license server computer is listed in your FLOW-3D license file. No FLEXlm license server components are installed.
Option 3 – “Server (license server)” -- Choose Option 3 if you wish to have your computer function only as a license server and you do not intend to run FLOW-3D simulations on it. This choice will only install the FLEXlm server on your computer. FLOW-3D itself will not be installed, and thus cannot be run on this computer.
Step Seven -- If you chose Option 1 or 3 in Step Six, a dialog will appear asking you to choose the type of key to which your license will be locked. The most common key type is a USB key and looks very similar to a USB memory stick. If you have a parallel port key (Windows only), choose that option. If your license will be locked to your Ethernet address (uncommon), then choose this option. If you are not sure what your license will be locked to, select the last option – “Don’t know.” All possible drivers will be installed. Select Next to continue.
Step Eight -- At this point, installation of FLOW-3D and all required drivers is ready to begin. Click Install to complete the installation.
Step Nine -- At this point, FLOW-3D should be installed and the final step is to install your license file. If you have already received your license file, simply copy it to the "licenses" directory and proceed to Step Eleven to start your license server. If you have not received your license file, follow the instructions in Step Ten to obtain a license file.
Step Ten -- In order to issue a license file, Flow Science needs both the host name and the host ID of your server. To obtain this information from your server, double-click on the lmtools.exe program file in the licenses subdirectory under the FLOW-3D installation directory and select the System Settings tab. If using a hardware key, provide the FLEXID and the Computer/Hostname to Flow Science. If you are not using a hardware key, provide Flow Science the Ethernet address and the Computer/Hostname.
Once your Hostname and Ethernet or FLEXID have been received, Flow Science will send you a license file ("flow3d.lic"), which will come in the form of an attachment to an email. It is an ASCII file with encryption codes that allow it to be used for only one Host_ID. Check the license file to be sure that it contains the Hostname and HOST_ID that matches your license server. Now copy the attachment to the "licenses" folder in your FLOW-3D installation directory.
Step Eleven -- Start the license server (Client/Server and Server installations only). In LMTOOLS, click on the Start/Stop/Reread tab to display the Start Server, Stop Server, and ReRead License File buttons. Click on the Start Server button to start the license server. If the message in the lower left corner reads, “Server Started” then the server successfully started. If it reads, “Server Start Failed,” select the Stop Server button and then select the Start Server button again. You should see the message, “Server started.” If not, contact Flow Science, Inc., at [email protected] or 505-982-0088.
If you chose Option 1 or 3 in Step Six of 29HNew Computer Installations, then, in order to ensure that the license server will be started each time you reboot your computer, you should go to the Config Services tab and make sure that the Start Server at Powerup and Use Services boxes are checked.
At this point, you should be ready to run FLOW-3D.
New Linux Installations
Installation Overview
To install the FLOW-3D software package on a Linux computer, you will need to accomplish the following: • Install FLOW-3D from the CD-ROM onto your hard disk using the “install_flow3d” script;
• Copy your license file into the "licenses" subdirectory and start the license server (if it is not already running);
• Execute the flow3d.sh (or flow3d.csh for c-shells) script to set the required environment variables.
Step-by-Step Procedure
Step One -- Insert the distribution CD into your CD drive.
Step Two -- Open a command prompt and set the current working directory to the CD mount directory and then to the "unix" subdirectory. For example, if the mount directory is "/cdrom", then:
cd /cdrom/unix
Step Three -- Run the installation script "install_flow3d" (this script will be in the current working directory): ./install_flow3d
Note: If this computer is only going to serve as your license server and you do not intend to run
FLOW-3D on it, then you can choose to install only the FLEXlm license server. On the other
hand, if this computer is only a client, you should install only the FLOW-3D files and the
FLOW-3D license on it.
Step Four -- Determine the "HOST_ID" information.
In order to receive your license file, you must first send Flow Science your computer’s Host_ID.
If you are a new user, Flow Science will send you a "Customer License Issuance/Renewal Form" to fill out and return, and on this form you provide the necessary information. In filling out your information form, you must be careful to distinguish between the number zero "0" and the letter "o." You will also need to be careful to distinguish between the lower-case letter "l" and the number one "1."
If you are an existing user, that is using a new license server, send an email to Flow Science
([email protected]) stating your name, the registered user’s name, your company name, and your
telephone number. Include the file "host_id.txt" as an attachment.
If you do not already know your computer’s Host_ID, you can find it out by running the script "get_host_id." Log on to the license server. Set your working directory to the "licenses" subdirectory in the distribution directory. One of the files in the "licenses" subdirectory is the script "get_host_id"; run this script to generate the output file "host_id.txt" which contains "host_id" information about your license server. For example, if the distribution directory is "/home/flow3d", then type:
cd /home/flow3d/licenses ./get_host_id
Step Five -- Install the license file: "flow3d.lic."
After Flow Science receives your "host_id" information (via "host_id.txt"), you will be sent an email with your license file included as an attachment. The FLOW-3D license file is "flow3d.lic" and should be copied
Step Six -- Start the license daemon (Server installs only)
To start the license server, first log in on the computer that will run the license server. Set your current working directory to the "licenses" subdirectory in the distribution directory. The license manager daemon is named lmgrd. To start the license daemon type:
./lmgrd -c full_license_file_path -l lmgrd.log &
where full_license_file_path is the complete path to the license file. The output is redirected to the log file "lmgrd.log." Be sure to include the "&" at the end so that the daemon will run in the background. For example, suppose the software distribution on the license server is installed in the directory "/home/flow3d." The complete path to the FLOW-3D license file would then be /home/flow3d/licenses/flow3d.lic. In this case, to start the license server, you would type:
./lmgrd -c /home/flow3d/licenses/flow3d.lic -l lmgrd.log &
Instructions for starting the license server in the Korn or Bourne shell can be found in Section 6.2 of the
FLEXlm End User Manual.
If you examine the contents of the "lmgrd.log", you will find a record of all license transactions. If you encounter any problems with FLOW-3D licensing, the problem can sometimes be determined by examining the contents of this file.
Note: If you intend to run FLOW-3D only on the computer that is your license server, skip Step Seven and Step Eight and proceed to Step Nine.
Step Seven -- Install the software distribution(s) for any client(s).
At this point, you have either installed the whole software distribution or just the licensing software on your license server. If you are using a "local installation" strategy and have clients other than the license server, you can now install a software distribution on each of the clients. If you have any clients that require "remote installation", then you must install, on the computer from which your client will run, a software package for the computer that the client is running on.
For each installation on a client computer running a supported Linux operating system, create a distribution directory on the desired disk, and then follow the same instructions that you used for the license server installations above.
Step Eight -- Copy the license file "flow3d.lic" into the client distribution directories.
If you installed the FLOW-3D software package on any clients, you will need to copy the FLOW-3D license file (flow3d.lic) from your license server into the "licenses" subdirectory on each of those clients.
For clients running Linux or Linux operating systems, another way to accomplish this result is to replace each of the FLOW-3D license files with a "symbolic link" to the FLOW-3D license file on your license server, rather than replacing it with the file itself. Of course, this method would require that the "licenses" directory on your license server be accessible (via NFS) to each of the other clients. For example, suppose that the distribution directory on your license server is "/users/flow3d" (the license file would then be "/users/flow3d/licenses/flow3d.lic"). Further, suppose that you installed a software package on another client in a directory there titled "/disk1/flow3d/SGI." To use a symbolic link to replace the license file on the second client:
cd /disk1/flow3d/SGI/licenses rm flow3d.lic (if necessary)
ln -s /users/flow3d/licenses/flow3d.lic flow3d.lic
The advantage of using "symbolic links" is that when you modify the FLOW-3D license file on the license server, the changes will automatically occur in all of the other "symbolically linked" license files. Otherwise,
you would need to manually modify the FLOW-3D license files on all of the other clients as well as the license file on your license server.
Step Nine -- Set the FLOW-3D environment variables
During installation, a file named flow3d.sh (and flow3d.csh for cshells) was created in the installation directory. These files contain the appropriate setting for environment variables needed to run FLOW-3D. These variables include:
Variable Bash shell
F3D_HOME export F3D_HOME=”install directory F3D_VERSION export F3D_VERSION=double
PATH export PATH=$F3D_HOME/local:$PATH
stacksize ulimit –s unlimited
LD_LIBRARY_PATH export LD_LIBRARY_PATH=$F3D_HOME/gui/lib
To set the required environment variables for your session, it is advisable to execute the flow3d.sh script from your .bashrc file if you are using a bash shell. If you are using a c shell, execute flow3d.csh from your .cshrc file. For example, if you intend to run FLOW-3D from a bash shell, add the line
source “FLOW-3D installation directory”/flow3d.sh
to your .bashrc file. If you intend to run FLOW-3D from a c shell, add the line source “FLOW-3D installation directory”/flow3d.csh
to your .cshrc file.
Step 10 -- Additional license server considerations.
• If the distribution directory on your license server is not being used as a FLOW-3D "home directory" by any client or by the license server itself, you can save some disk space on that computer by deleting all of its subdirectories except "licenses." In other words, if the license server is only being used to run the license daemon, then you can delete the unneeded directories (those other than "licenses"): local, help,
examples, GUI, utilities, prehyd, double, prehyd_s, single, flscon, and pltfsi.
• If you wish to install the license file in a directory other than "$F3D_HOME/licenses", you will need to set the environment variable "F3DTKNUX_LICENSE_FILE" to the full path where the license file resides (see Steps 7 and 8 for examples of setting environment variables).
• If the environment variable "F3D_HOME" contains the character "@" as part of the path, the license file will need to be moved to an alternate location since the path to the license file cannot contain the character "@." Use the environment variable "F3DTKNUX_LICENSE_FILE" (as described above) to set the location of the license file.
1.2.4 Upgrade Installation Instructions
Beginning with FLOW-3D Version 9.3, previous installations are not removed. If Version 9.2 is installed on your computer, it will not be disturbed. However, the environment variables will be changed to Version 9.3.
To install a FLOW-3D software package upgrade on a Windows computer, follow the steps described in 31HNew
Installations, above.
Linux Installations
To install FLOW-3D Version 9.3 as an upgrade on any Linux computer, follow these steps:
• Insert the Linux installation CD into your CD drive. Depending on what type of computer you are using, the CD may mount automatically, or you may have to mount it with a "mount" command.
Note: the device names and the mount directory are computer dependent.
• Set the current working directory to the CD mount directory and then to the "unix" subdirectory. For example, if the mount directory is "/cdrom", then:
cd /cdrom/unix
• Run the installation script "install_flow3d" (this script will be in the current working directory): ./install_flow3d
The script will launch an installation GUI that will guide you through the installation process.
Running Older Versions of Installations of
FLOW-3D
As mentioned above, when Version 9.3 is installed, previous installations are not removed. Some users prefer to retain older versions of the code for a variety of reasons. In order to run a simulation using a prior version of FLOW-3D, you will need to change the value of your user environment variable "f3d_home" to the path of the old version and change the “path” environment variable to point to the local directory of the old version.
Windows
To change the value of your "f3d_home" on Windows, you need to right-click on the My Computer icon on your desktop and open Properties. Then, under the Advanced tab, click on the Environment Variables button and choose Edit under User Variables. There, change the value of f3d_home to the path of the old version. To complete this process, click on Apply and then reboot your computer.
Linux
There a number of ways to change the value of your FLOW-3D environment variables on Linux. You may modify the flow3dvars.sh file (for Bash shells) or the flow3dvars.csh file (for C shells), or you may set the environment variables directly in your .bashrc or .cshrc files.
The flow3dvars.sh and flow3dvars.csh files are located in the {FLOW-3D installation directory}/local directory. Using a text editor, change the value of F3D_HOME to point to the location of the installation you wish to run. For example, if FLOW-3D Version 9.2.1 is located in /home/user/flow3d/v9.2.1, change the export statement for F3D_HOME to read
export F3D_HOME=/home/user/flow3d/v9.2.1
The PATH variable is set using F3D_HOME and so does not need to be set. You will need to source flow3dvars.sh or flow3dvars.csh in order for the changes to take effect. To source these files, type
source flow3dvars.sh (Bash shell) or source flow3dvars.csh (C shell)
To set the environment variables in the .bashrc or .cshrc files simply add the definitions shown in flow3dvars.sh or flow3dvars.csh and make changes so they point to the installation you wish to run.
Note: A complete copy of the installation chapter from the FLOW-3D User’s Manual is contained on the distribution CD in the folder "INSTALLATION_INSTRUCTIONS." Point your browser to "HelpFile.htm."
1.2.5 Installing a New/Replacement License File
If you have been issued a new license file for any reason—expiration of your license, server change, etc.— then you should follow these simple steps to replace your license file.
Your FLOW-3D license file (flow3d.lic) is typically sent as an email attachment. The license file is a text file with encryption codes that lock your license to a USB dongle or Ethernet address. The license file contains tokens which authorize the use of FLOW-3D suite of programs.
There are two steps to installing the license file: copy the license file to the appropriate location on your hard drive, and then start or reread the license file.
Step 1
Save the FLOW-3D license file (flow3d.lic) into the “licenses” subdirectory of the FLOW-3D installation directory on the computer acting as the license server. The license file also needs to be saved to this directory on any computers acting as FLOW-3D clients.
Windows - If FLOW-3D is installed in C:\FLOW3D\v9.3, then you would copy flow3d.lic to C:\FLOW3D\v9.3\licenses
Linux - If FLOW-3D is installed in \home\FLOW3D\v9.3, then you would copy flow3d.lic to \home\FLOW3D\v9.3\licenses
On Linux clients, it is sufficient to set the environment variable F3DTKNUX_LICENSE_FILE to the IP address of the license server. For example, if the IP address of the license server is 192.168.1.14, the following line should be added to the .bashrc (for BASH shells):
export F3DTKNUX_LICENSE_FILE=192.168.1.14
Step 2
Start the license server or reread the license file. For new installations, or if the license server has been stopped, follow the instructions for Starting the License Server. If the license server is running, follow the instructions for Rereading the License File.
Starting the License Server
Windows: Open FLOW-3D and select LMTOOLS from the Utilities menu. The LMTOOLS utility will open. In the Service/License File tab, select FLOW-3D FLEXlm License Manager. Then change to the Start/Stop/Reread tab. Click the Start Server button. A message indicating “Server Started” should appear in the status bar at the bottom of the LMTOOLS window. Change to the Server Status tab and click the Perform Status Enquiry button. Messages should appear in the window indicating that the server is running. Linux: Open a terminal window and change to the “licenses” directory in the FLOW-3D installation directory. Start the license server by typing:
./lmgrd –c flow3d.lic –l flow3d.log & Check the status of the server by typing
./lmutil lmdiag –c flow3d.lic
Rereading a License File
If the license server is already running, the license file simply needs to be reread.
Windows: Open FLOW-3D and select LMTOOLS from the Utilities menu. The LMTOOLS utility will open. On the Service/License File tab, select FLOW-3D FLEXlm License Manager. Then change to the Start/Stop/Reread tab. Click the ReRead License File button. A message indicating “Reread Server License File Completed” should appear in the status bar at the bottom of the LMTOOLS window.
Linux: Open a terminal window and change to the “licenses” directory in the FLOW-3D installation directory. Reread the license file by typing
./lmutil lmreread –c flow3d.lic Check the status of the server by typing
./lmutil lmdiag –c flow3d.lic
1.2.6 Licensing
Portability
License files locked to USB dongles provide the most portability since the dongle can be moved between computers easily. The only change necessary is the SERVER line in the license file. For example, to move a USB dongle from a server named “Kelvin” to a server named “Celsius”, open the flow3d.lic license file in an editor such as Notepad and change the first line to read
SERVER Celsius FLEXID= “your USB key ID”
Then start the license server using the methods described above in Starting the License Server.
Moving license files locked to Ethernet addresses require special arrangements with Flow Science. To request a license be moved from an Ethernet address, please email [email protected].
1.2.7 Uninstalling
FLOW-3D
Uninstall instructions vary depending on whether you are running FLOW-3D on Windows or on a Linux workstation.
Windows Installations
Uninstalling FLOW-3D is fairly simple. Double-click on the lmtools.exe program file in the licenses subdirectory under the FLOW-3D installation directory, open the Start/Stop/Reread tab and click on the Stop button. You should see a message "Server Stopped" under the Status button. Next, run the Add/Remove Programs applet from the Control Panel. Double-click on FLOW-3D in the Install/Uninstall list. This will remove FLOW-3D from your system.
If you installed the FLEXlm server on your computer, it can be removed from the system. The best way to do this is to run the installs.exe program. Insert the FLOW-3D CD into your CD-ROM drive and use your Explore function to find the licenses directory on the CD. Open the file installs.exe. From a command prompt, uninstall the FLEXlm server by typing:
x:\licenses\installs.exe –r
FLEXlm License Manager service removed
Linux Installations
Delete the FLOW-3D home directory. If boot-up scripts were modified to start the license server at boot time, then remove those modifications.
1.2.8 Special Notes for Users with SMP Parallel License
As installed, FLOW-3D is capable of running in either multi-processor mode or in single-processor mode, upon your selection.
In order to run FLOW-3D in SMP parallel mode (for shared memory workstations—“SMP”), a parallel token, “hydr3p” must be available at the time you initiate the FLOW-3D solver. If you have acquired a parallel token from Flow Science for a parallel license, you will have been sent a license file that includes one or more parallel tokens (hydr3dp).
To run the parallel version from the FLOW-3D GUI, click on Preferences in the main menu and select Runtime. The Version Options window below opens:
In the Number of Processors dropdown, you may choose whether to run in serial mode (1 processor) or in parallel mode (2 or more). The number of processors on your computer will be displayed in the dropdown list under Parallel code if your license file contains parallel tokens. To run in parallel mode, you must decide how many processors you wish to use. Your choices will be limited to the maximum number of processors detected by FLOW-3D when the GUI was started (on Windows the number of processors is limited to 8). Note: If you are running FLOW-3D on a single-processor computer, you will only be able to select the
1 processor option; the parallel options will be inactive even if a parallel token is available If you have chosen to run in parallel mode, the solver will not run if no parallel token is available when you click Run Solver (if, for example, other users have checked it out all available parallel tokens). If you wish, you may choose to run FLOW-3D in serial mode if no parallel tokens are available. You make this choice by selecting the box next to the Run Serial Code if Parallel Tokens in Use option. If you do not make this choice, then your solution will not proceed unless and until a parallel token becomes available.
1.3
DIRECTORY STRUCTURE AND ENVIRONMENT
VARIABLES
There are two primary elements in the FLOW-3D installation: the FLOW-3D installation and the FLEXlm license server installation. The FLEXlm license server is only required for client/server and server installations.
All of the elements of FLOW-3D itself are placed in the F3D_HOME directory, where F3D_HOME is an environment variable that represents the root directory you have chosen during installation. This directory tree contains all the executables, runscripts, supporting files, and examples. Both single precision and double precision versions are included. Customizable versions are contained under the prehyd (double precision) and prehyd_s (single precision) directories. The components of FLEXlm are installed in the licenses sub-directory. The license file, flow3d.lic, and the daemons lmgrd and F3DTKNUX are always required on the license server.
1.3.1 Environment
Variables
There are a number of environment variables are required for FLOW-3D to run. On Windows, all required environment variables are set by the installation. On Linux, the environment variables are set in the flow3d.sh and flow3d.csh files.
The F3D_HOME environment variable represents the installation directory. For example, on Windows (if
FLOW-3D is installed in c:\flow3d), it would be:
F3D_HOME = c:\flow3d On Linux, an example might be:
F3D_HOME = /usr/people/flow3d
The F3D_VERSION environment variable, represents the version which is to be run (i.e., double precision, single precision, etc.). F3D_VERSION should be set to one of the following.
The PATH environment variable must be modified to include the F3D_HOME/local directory. For example, on Windows:
PATH=%F3D_HOME\local;%PATH% And, on Linux:
PATH=$F3D_HOME/local:$PATH
The F3DTKNUX_LICENSE_FILE environment variable points to the location of the FLOW-3D license file. On the server, this environment variable must point to the actual license file. For example, if the license file is located on a Windows computer in c:\flow3d\licenses,
F3DTKNUX_LICENSE_FILE=C:\flow3d\licenses
On client computers, it is sufficient to simply point to the server by name or IP address. For example, if the license server is named Celsius, then
F3DTKNUX_LICENSE_FILE=@Celsius
1.3.2
FLOW-3D File Naming Convention
The input and output files used by FLOW-3D are shown in the diagram below. There may be other files for special models and options, such as STL geometry input files or tabular input for the Non-inertial Reference Frame model that are not shown.
FLOW-3D input and output files.
The report file created by the preprocessor and amended by the solver contains a concise description of the problem setup and is formatted for printing.