Permalink
Browse files

document MagneticLens.pm

  • Loading branch information...
1 parent a049b46 commit 65870cd7d8077c8b569ce46bdcc85955d6956d89 @jberger committed Oct 25, 2012
Showing with 57 additions and 1 deletion.
  1. +1 −1 lib/Physics/UEMColumn/DCAccelerator.pm
  2. +56 −0 lib/Physics/UEMColumn/MagneticLens.pm
@@ -116,7 +116,7 @@ Defined as C<voltage> / C<length>
=item C<effect>
-Returns an hash reference of effect subroutine references (C<M_t>, C<M_z>, C<acc_z>). See L<Physics::UEMColumn::Element/METHODS> for more.
+Returns a hash reference of effect subroutine references (C<M_t>, C<M_z>, C<acc_z>). See L<Physics::UEMColumn::Element/METHODS> for more.
=item C<est_exit_vel>
@@ -39,3 +39,59 @@ __PACKAGE__->meta->make_immutable;
1;
+=head1 NAME
+
+Physics::UEMColumn::MagneticLens - A class representing a magnetic lens in a UEM system
+
+=head1 SYNOPSIS
+
+ use Physics::UEMColumn alias => ':standard';
+ my $lens = MagneticLens->new(
+ location => $position . 'cm',
+ length => $length . 'cm',
+ strength => $strength,
+ );
+
+=head1 DESCRIPTION
+
+L<Physics::UEMColumn::MagneticLens> is a class representing a magnetic lens in a UEM system. It is a subclass of L<Physics::UEMColumn::Element> and inherits its attributes and methods. Additionally it provides:
+
+=head1 ATTRIBUTES
+
+=over
+
+=item C<stength>
+
+Quantifies the strength of the magnetic lens. While this number is conceptually analytical, in practice this number is very hard to determine other than by comparison to lens in question. With this in mind, no unit is used on this attribute.
+
+=item C<order>
+
+The super-Gaussian order C<exp( - $x ** ( 2 * $order ) )> determining the shape of the lens. Default is C<1> (a Gaussian).
+
+=back
+
+=head1 METHODS
+
+=over
+
+=item C<effect>
+
+Returns a hash reference of effect subroutine references (C<M_t>). See L<Physics::UEMColumn::Element/METHODS> for more.
+
+=back
+
+=head1 SOURCE REPOSITORY
+
+L<http://github.com/jberger/Physics-UEMColumn>
+
+=head1 AUTHOR
+
+Joel Berger, E<lt>joel.a.berger@gmail.comE<gt>
+
+=head1 COPYRIGHT AND LICENSE
+
+Copyright (C) 2012 by Joel Berger
+
+This library is free software; you can redistribute it and/or modify
+it under the same terms as Perl itself.
+

0 comments on commit 65870cd

Please sign in to comment.