vim-foam-programmer

Helpful utilities for the OpenFOAM programmer.

Author

Matthew C. Jones [email protected]

Installation

Install using vim-plug,

Plug `vim-foam-programmer`

Features

This plugin provides additional support for creating, editing, or viewing OpenFOAM source code files using Vim. The specific features are listed.

• Automatically searches OpenFOAM makefiles for linked header files and adds them Vim's path.
  • Allows for opening included header files inside Vim with gf
  • Allows for built-in Vim include and definition searching
    • Use [_CTRL-i, [_CTRL-d, CTRL-w_i, CTRL-w_d, etc.
    • See :help include-search definition-search
• Convenient command to build Ctags that references custom user files as well as OpenFOAM source code.
  • Run :FoamCtags to generate tags file
  • Use g] Ctrl-] and Ctrl-t to navigate through functions and variables of interest
  • See :help tag-matchlist
  • Requires external dependency: exuberant-ctags or universal-ctags
• Automatically set OpenFOAM files to cpp filetype for better readability. This is disabled by default. To enable, place the following line in your vimrc file.

let g:foam#programmer#syntax = 'true'

See Also

• Vim-Foam for syntax highlighting.

• YouCompleteMe and YCM-Generator for text completion. Use the following command in the project base directory.

:YcmGenerateConfig -verbose --preserve-environment --force

License

Copyright (c) 2020 Matthew C. Jones. Distributed under The MIT License (MIT). See LICENSE file.