Files
LIGGGHTS-PFM/doc/liggghts_2.X_coding.html
2012-07-06 15:28:20 +02:00

43 lines
1.1 KiB
HTML

<HTML>
<CENTER><A HREF = "http://www.cfdem.com">LIGGGHTS WWW Site</A> - <A HREF = "http://lammps.sandia.gov">LAMMPS WWW Site</A> - <A HREF = "Manual.html">LIGGGHTS Documentation</A> - <A HREF = "Section_commands.html#comm">LIGGGHTS Commands</A>
</CENTER>
<HR>
<H1>LIGGGHTS 2.X Coding Manual
</H1>
<H2>Introduction:
</H2>
<P>This is a short coding manual for LIGGGHTS 2.X
</P>
<H2>A short list of guidelines
</H2>
<LI>class data members should be denoted with a <B>_</B> (like <I>x_</I>)
<LI>inline access functions should be used to get access to <I>x_</I>, like <I>x()</I>
<LI>class data members , both <I>x_particle_</I> and <I>xParticle_</I> are allowed
<LI>template params should be written in LARGE_CAPS
<LI>file names like fix_mesh_gran.cpp, mesh_mover.h
<LI>fix style fix move/mesh/gran is in file fix_move_mesh_gran.cpp/h
<LI>header guard in file fix_foo_model.h like LMP_FIX_FOO_MODEL_H
<LI>coding format should be ANSI
<LI>for fixes, use error->fix_error to throw error messages in constructors, this enhances object orientation
<H2>Files which are especially
</H2>
</HTML>