Howto adding a new solver to foamX

From OpenFOAMWiki
Jump to: navigation, search

Valid versions: OF version 14.png

FoamX at start-up will look through through a predefined set of directories to find directories with a FoamX subdirectory. These directories are taken to be utilities or solvers which need to be added to FoamX. For solvers it looks through directories

  • $WM_PROJECT_DIR/applications/solvers
  • $WM_PROJECT_USER_DIR/applications/solvers,

for utilities it looks through directories

  • $WM_PROJECT_DIR/applications/utilities
  • $WM_PROJECT_USER_DIR/applications/utilities.

The easiest way is to copy the FoamX directory of an existing solver/utility and rename the top .cfg file to your solver. Make sure that the

  • directory name
  • top level solver name
  • .cfg file in the FoamX directory

are all consistent.

For example, if your application is similar to icoFoam, take

$WM_PROJECT_DIR/applications/solvers/incompressible/icoFoam/FoamX

and copy it to

$WM_PROJECT_USER_DIR/applications/solvers/myFoam

where myFoam is the name of your new solver and move

FoamX/icoFoam.cfg

to

FoamX/myFoam.cfg

Adapt the configuration file and the dictionaries to your needs and change /Make/files to match your application name.

Create a case (right click on the root directory in the case browser) and you will have myFoam to choose from.