ICODE-ADC/lammps
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

git-svn-id: svn://svn.icms.temple.edu/lammps-ro/trunk@10876 f3b2605a-c512-4ea7-a41b-209d697bcdaa

Browse Source
This commit is contained in:
sjplimp
2013-10-24 18:04:27 +00:00
parent 09c8526430
commit b0d7fe1f26
2 changed files with 40 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
doc/Section_modify.html
View File

@ -661,13 +661,13 @@ it if LAMMPS changes.
features of various kinds to LAMMPS. Packages are simply collections features of various kinds to LAMMPS. Packages are simply collections
of one or more new class files which are invoked as a new "style" of one or more new class files which are invoked as a new "style"
within a LAMMPS input script. If designed correctly, these additions within a LAMMPS input script. If designed correctly, these additions
do not require changes to the main core of LAMMPS; they are simply typically do not require changes to the main core of LAMMPS; they are
add-on files. If you think your new feature requires non-trivial simply add-on files. If you think your new feature requires
changes in core LAMMPS files, you'll need to <A HREF = "http://lammps.sandia.gov/authors.html">communicate with the non-trivial changes in core LAMMPS files, you'll need to <A HREF = "http://lammps.sandia.gov/authors.html">communicate
developers</A>, since we may or may with the developers</A>, since we
not want to make those changes. An example of a trivial change is may or may not want to make those changes. An example of a trivial
making a parent-class method "virtual" when you derive a new child change is making a parent-class method "virtual" when you derive a new
class from it. child class from it.
</P> </P>
<P>Here is what you need to do to submit a user package or single file <P>Here is what you need to do to submit a user package or single file
for our consideration. Following these steps will save time for both for our consideration. Following these steps will save time for both
@ -676,6 +676,14 @@ you and us. See existing package files for examples.
<UL><LI>All source files you provide must compile with the most current <UL><LI>All source files you provide must compile with the most current
version of LAMMPS. version of LAMMPS.
<LI>If you want your file(s) to be added to main LAMMPS or one of its
standard packages, then it needs to be written in a style compatible
with other LAMMPS source files. This is so the developers can
understand it and hopefully maintain it. This basically means that
the code accesses data structures, performs its operations, and is
formatted similar to other LAMMPS source files, including the use of
the error class for error and warning messages.
<LI>If your contribution is a single file (actually a *.cpp and *.h file) <LI>If your contribution is a single file (actually a *.cpp and *.h file)
it can most rapidly be added to the USER-MISC directory. Send us the it can most rapidly be added to the USER-MISC directory. Send us the
one-line entry to add to the USER-MISC/README file in that dir, along one-line entry to add to the USER-MISC/README file in that dir, along
@ -694,10 +702,11 @@ directory.
<LI>Your new source files need to have the LAMMPS copyright, GPL notice, <LI>Your new source files need to have the LAMMPS copyright, GPL notice,
and your name at the top, like other LAMMPS source files. They need and your name at the top, like other LAMMPS source files. They need
to create a class that is inside the LAMMPS namespace. Other than to create a class that is inside the LAMMPS namespace. If the file is
that, your files can do whatever is necessary to implement the new for one of the USER packages, including USER-MISC, then we are not as
features. They don't have to be written in the same stylistic format picky about the coding style (see above). I.e. they do not need to be
and syntax as other LAMMPS files, though that would be nice. in the same stylistic format and syntax as other LAMMPS files, though
that would be nice.
<LI>Finally, you must also send a documentation file for each new command <LI>Finally, you must also send a documentation file for each new command
or style you are adding to LAMMPS. This will be one file for a or style you are adding to LAMMPS. This will be one file for a

31
doc/Section_modify.txt
View File

@ -635,13 +635,13 @@ The previous sections of this doc page describe how to add new
features of various kinds to LAMMPS. Packages are simply collections features of various kinds to LAMMPS. Packages are simply collections
of one or more new class files which are invoked as a new "style" of one or more new class files which are invoked as a new "style"
within a LAMMPS input script. If designed correctly, these additions within a LAMMPS input script. If designed correctly, these additions
do not require changes to the main core of LAMMPS; they are simply typically do not require changes to the main core of LAMMPS; they are
add-on files. If you think your new feature requires non-trivial simply add-on files. If you think your new feature requires
changes in core LAMMPS files, you'll need to "communicate with the non-trivial changes in core LAMMPS files, you'll need to "communicate
developers"_http://lammps.sandia.gov/authors.html, since we may or may with the developers"_http://lammps.sandia.gov/authors.html, since we
not want to make those changes. An example of a trivial change is may or may not want to make those changes. An example of a trivial
making a parent-class method "virtual" when you derive a new child change is making a parent-class method "virtual" when you derive a new
class from it. child class from it.
Here is what you need to do to submit a user package or single file Here is what you need to do to submit a user package or single file
for our consideration. Following these steps will save time for both for our consideration. Following these steps will save time for both
@ -650,6 +650,14 @@ you and us. See existing package files for examples.
All source files you provide must compile with the most current All source files you provide must compile with the most current
version of LAMMPS. :ulb,l version of LAMMPS. :ulb,l
If you want your file(s) to be added to main LAMMPS or one of its
standard packages, then it needs to be written in a style compatible
with other LAMMPS source files. This is so the developers can
understand it and hopefully maintain it. This basically means that
the code accesses data structures, performs its operations, and is
formatted similar to other LAMMPS source files, including the use of
the error class for error and warning messages. :l
If your contribution is a single file (actually a *.cpp and *.h file) If your contribution is a single file (actually a *.cpp and *.h file)
it can most rapidly be added to the USER-MISC directory. Send us the it can most rapidly be added to the USER-MISC directory. Send us the
one-line entry to add to the USER-MISC/README file in that dir, along one-line entry to add to the USER-MISC/README file in that dir, along
@ -668,10 +676,11 @@ directory. :l
Your new source files need to have the LAMMPS copyright, GPL notice, Your new source files need to have the LAMMPS copyright, GPL notice,
and your name at the top, like other LAMMPS source files. They need and your name at the top, like other LAMMPS source files. They need
to create a class that is inside the LAMMPS namespace. Other than to create a class that is inside the LAMMPS namespace. If the file is
that, your files can do whatever is necessary to implement the new for one of the USER packages, including USER-MISC, then we are not as
features. They don't have to be written in the same stylistic format picky about the coding style (see above). I.e. they do not need to be
and syntax as other LAMMPS files, though that would be nice. :l in the same stylistic format and syntax as other LAMMPS files, though
that would be nice. :l
Finally, you must also send a documentation file for each new command Finally, you must also send a documentation file for each new command
or style you are adding to LAMMPS. This will be one file for a or style you are adding to LAMMPS. This will be one file for a