Permalink
Browse files

add additional caveat about the solver_opts

  • Loading branch information...
1 parent 7d76152 commit 1fce485dbf0bf804d14f024792e53cf63ce0fc89 @jberger committed Nov 19, 2012
Showing with 16 additions and 2 deletions.
  1. +16 −2 lib/Physics/UEMColumn.pm
@@ -1,6 +1,6 @@
package Physics::UEMColumn;
-our $VERSION = "0.900_001";
+our $VERSION = '0.900';
$VERSION = eval $VERSION;
=head1 NAME
@@ -44,7 +44,21 @@ This extended model calculates the dynamics of electron pulse propagation for an
=head2 Caveats
-The model is a self-similar Gaussian model, and therefore a mean-field model; futher the modeling of external forces is restricted to perfect lensing. Also, the equations governing the generation of pulse (and therefore the initial parameters), are as-yet unpublished, and unexplained. Should this not be preferable, one should manually create a L<Physics::UEMColumn::Pulse> object, rather than allowing the C<Physics::UEMColumn::Photocathode> object to create one automatically.
+=over
+
+=item *
+
+The model is a self-similar Gaussian model, and therefore a mean-field model; futher the modeling of external forces is restricted to perfect lensing.
+
+=item *
+
+The equations governing the generation of pulse (and therefore the initial parameters), are as-yet unpublished, and unexplained. Should this not be preferable, one should manually create a L<Physics::UEMColumn::Pulse> object, rather than allowing the C<Physics::UEMColumn::Photocathode> object to create one automatically.
+
+=item *
+
+While sensible defaults have been given to the underlying solver's options (see L</solver_opts>, these defaults may not always produce a desired or physically correct output. Care should be taken to be ensure that the solver is setup correctly especially for the scales involved in your particular simulation.
+
+=back
=head2 Examples

0 comments on commit 1fce485

Please sign in to comment.