This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
docs:classes:fieldsymmetry [2009/02/16 11:52] gibson |
docs:classes:fieldsymmetry [2009/02/16 16:30] wikiadmin |
||
---|---|---|---|
Line 29: | Line 29: | ||
</latex> | </latex> | ||
- | In C++ code, elements of the symmetry group can be defined as follows | + | The following is a brief overview of FieldSymmetry functionality. For a complete description, |
+ | see the header file {{:librarycode:symmetry.h}}. | ||
+ | |||
+ | ====== Constructors / Initialization ====== | ||
+ | |||
+ | In C++ code, elements of the symmetry group can initialized as follows, | ||
+ | where %%sx,sy,sz%% are of type %%int%% and %%ax, az%% are of type %%Real%%. | ||
<code c++> | <code c++> | ||
FieldSymmetry sigma0(sx, sy, sz, ax, az, s); | FieldSymmetry sigma0(sx, sy, sz, ax, az, s); | ||
- | FieldSymmetry sigma1(sx, sy, sz, ax, az); // The s argument s defaults to 1 | + | FieldSymmetry sigma1(sx, sy, sz, ax, az); // the s argument s defaults to 1 |
FieldSymmetry sigma2(sx, sy, sz); // s defaults to 1; ax,az to 0 | FieldSymmetry sigma2(sx, sy, sz); // s defaults to 1; ax,az to 0 | ||
- | FieldSymmetry tau(ax, az); // Pure translation: s,sx,sy,sz default to 1 | + | FieldSymmetry tau(ax, az); // pure translation: s,sx,sy,sz default to 1 |
- | FieldSymmetry identity; // The identity: s defaults to 1; ax,az to 0; sx,sy,sz to 1 | + | FieldSymmetry identity; // the identity: s defaults to 1; ax,az to 0; sx,sy,sz to 1 |
</code> | </code> | ||
- | where sx,sy,sz are of type int and ax, az are of type Real. FieldSymmetries act on each | + | |
- | other and velocity fields as follows | + | ===== Operations ===== |
+ | |||
+ | FieldSymmetries act on each other and velocity fields as follows | ||
<code c++> | <code c++> | ||
Line 75: | Line 83: | ||
</code> | </code> | ||
- | For a complete description of the FieldSymmetry class, see the header file fieldsymmetry.h. | + | |