/Foam.vim

OpenFOAM syntax for Vim

Primary LanguageVim script

Welcome

This short intruduction includes the steps which are necessary to get this application up and running.

OpenFOAM Versions

  • Generated for all versions but adopted to 4.x

What is this repository for?

  • This extension to the vim editor allows you to highlight a lot of OpenFOAM keywords
  • Version 4.x (represents the version of OpenFOAM)
  • Developed by Holzmann-cfd
  • Modified and extended by Ferdinand Leinbach

How do add the stuff to my vim?

  • In general you should use pathogen for keeping your vim folder clean and easy to manage
  • For that purpose check out that site: https://github.com/tpope/vim-pathogen
  • After pathagon is installed, go into your bundle directory

cd $HOME/.vim/bundle

  • and clone the vim extension for OpenFOAM

git clone https://bitbucket.org/shor-ty/vimextensionopenfoam.git

  • Done. If you open the OpenFOAM files now, the plugin should be used

Change color and keywords

  • If you have questions, hints or any suggestions please email me
  • If you want to use your own colorscheme just change the global variable in $HOME/.vimrc

foam256_use_custom_colors=0

  • If you insert more keywords or modify the files please make a pull request

Version Changes

Version 4.x

  • Renewed the README file for the correct usage with pathogen
  • Added keywords for the dynamicMeshDict
  • Changed the colorscheme (build a new one)
  • Updated keywords and other stuff

Version 4.0

  • Updated the install script (remove issue #1 and #2)
  • Modified keymapping.vim to use the foam256 colorscheme
  • Changed some format stuff in the added files
  • Merged Ferdinand Leinbach's modifications which result in Version 4.0
  • Added ability to make colorscheme foam256 optional and use user default instead
  • Calls and calling with autogroups now
  • Regular plugin-folder structure

Version 3.0

  • Rearanged the files
  • Insert new keywords
  • Autocomplete BC

Version 2.1

  • Split the openfoam.vim file into foam tree in syntax/openfoam/*
  • Added check into install script to check if there is already the entrys available in $HOME/.vimrc

Version 2.0

  • Added new keywords

Thanksgiving

  • Karl-Johan Nogenmyr
  • Ferdinand Leinbach