Doxygen is used to quickly browse all source files as well as checking all the properties of the classes and namespaces. The inheritance diagram of any class along its public member functions and derived classes are obtained by simply clicking on the class name appearing in the list. Once clicked, a list ordered alphabetically of all classes defined in OpenFOAM® is displayed. Once opened, click on the Classes button that appears in the menu in the upper part of the screen. To start, either open the browser at the address or open the file $WM_PROJECT_DIR/doc/Doxygen/html/index.html. This latest option yields always up to date documentation. The second option is to access Doxygen on the web at the address /docs/cpp/. The first is to generate the documents by direct compilation on the local machine (the main files are placed in $WM_PROJECT_DIR/doc/Doxygen). Two options are available to access Doxygen. Doxygen uses the UML () graph formalism and is capable of visually displaying the relations between the various classes, inheritance diagrams, and collaboration diagrams, which are all generated automatically as easily browsed HTML documents. OPENFOAM DOXYGEN SOFTWAREIt is an open source software that generates automatic documentation from annotated C++ sources. Solver for energy transport and thermodynamics on a frozen flow fieldĪdjointOutletPressureFvPatchScalarField.CĪdjointOutletPressureFvPatchScalarField.HĪdjointOutletVelocityFvPatchVectorField.CĪdjointOutletVelocityFvPatchVectorField.A critical tool used with OpenFOAM® is Doxygen. Solver for steady or transient fluid flow and solid heat conduction, with conjugate heat transfer between regions, buoyancy effects, turbulence, reactions and radiation modelling Read the control parameters used in the solidĬalculates and outputs the mean and maximum Diffusion Numbers for the solid regions Reduction of time-step is immediate, but increase is damped to avoid unstable oscillations Reset the timestep to maintain a constant maximum courant and diffusion Numbers. Set the initial timestep for the CHT MultiRegion solver Steady-state solver for buoyant, turbulent flow of compressible fluids, including radiation, for ventilation and heat-transferĬalculates and outputs the mean and maximum Courant Numbers for the fluid regions Transient solver for buoyant, turbulent flow of compressible fluids for ventilation and heat-transfer, with optional mesh motion and mesh topology changes Solves the Black-Scholes equation to price commodities Solver for magnetohydrodynamics (MHD): incompressible, laminar flow of a conducting fluid under the influence of a magnetic field Solver for the magnetic field generated by permanent magnets Molecular dynamics solver for fluid dynamicsĭirect numerical simulation solver for boxes of isotropic turbulence Solver to equilibrate and/or precondition molecular dynamics systems Steady-state solver for turbulent flow of compressible fluidsĭirect simulation Monte Carlo (DSMC) solver for, transient, multi-species flows Steady-state solver for turbulent flow of compressible fluids, with implicit or explicit porosity treatment and optional sources Transient solver for turbulent flow of compressible fluids for HVAC and similar applications, with optional mesh motion and mesh topology changes Solver for combustion with chemical reactionsĬalculates the mean and maximum wave speed based Courant Numbersĭensity-based compressible flow solver based on central-upwind schemes of Kurganov and Tadmor with support for mesh-motion and topology changes Solver for combustion with chemical reactions using density based thermodynamics package Solver for combustion with chemical reactions using a density based thermodynamics package with enhanced buoyancy treatment Reduction of time-step is immediate but increase is damped to avoid unstable oscillationsĬalculates and outputs the mean and maximum Courant Numbers Reset the timestep to maintain a constant maximum courant Number. Solver for compressible premixed/partially-premixed combustion with turbulence modelling Reset the timestep to maintain a constant maximum Courant numbers. Transient solver for fires and turbulent diffusion flames with reacting particle clouds and surface film modelling Solver for cold-flow in internal combustion engines Solver for chemistry problems, designed for use on single cell cases to provide comparison against other chemistry solvers, that uses a single cell mesh, and fields created from the initial conditions Solves the steady or transient transport equation for a passive scalar Potential flow solver which solves for the velocity potential, to calculate the flux-field, from which the velocity field is obtained by reconstructing the flux
0 Comments
Leave a Reply. |
Details
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |