Skip to content

Commit

Permalink
src/analysis/ typo fixes
Browse files Browse the repository at this point in the history
Typo fixes without any extraneous whitespace corrections.
  • Loading branch information
luzpaz committed Oct 28, 2018
1 parent 102d311 commit 0c3677e
Show file tree
Hide file tree
Showing 69 changed files with 130 additions and 136 deletions.
24 changes: 9 additions & 15 deletions SRC/analysis/algorithm/SolutionAlgorithm.tex
Original file line number Diff line number Diff line change
Expand Up @@ -11,33 +11,33 @@
\indent MovableObject \\
\indent\indent {\bf SolutionAlgorithm} \\

\noindent {\bf Description} \\
\noindent {\bf Description} \\
\indent The SolutionAlgorithm class is an abstract base class. Its purpose
is to define the interface common among all its subclasses. A
SolutionAlgorithm object performs the steps in the analysis by specifying
the sequence of operations to be performed by members in the analysis
aggregation.\\


\noindent {\bf Class Interface} \\
\indent // Constructor \\
\noindent {\bf Class Interface} \\
\indent // Constructor \\
\indent {\em SolutionAlgorithm(int classTag);}\\ \\
\indent // Destructor \\
\indent {\em virtual~ $\tilde{}$SolutionAlgorithm();}\\ \\
\indent // Public Methods \\
\indent {\em virtual int domainChanged(void); } \\
\indent {\em virtual int addRecorder(Recorder \&theRecorder);}\\
\indent {\em virtual int addRecorder(Recorder \&theRecorder);}\\
\indent {\em virtual int record(int track); } \\
\indent {\em virtual int playback(int track); } \\


\noindent {\bf Constructor} \\
\indent {\em SolutionAlgorithm(int classTag);}\\
\noindent {\bf Constructor} \\
\indent {\em SolutionAlgorithm(int classTag);}\\
The integer {\em classTag} is passed to the MovableObject classes
constructor. \\

\noindent {\bf Destructor} \\
\indent {\em virtual~ $\tilde{}$SolutionAlgorithm();}\\
\indent {\em virtual~ $\tilde{}$SolutionAlgorithm();}\\
Invokes the destructor on any recorder object added to the
SolutionAlgorithm and releases memory used to hold pointers to the
recorder objects. \\
Expand All @@ -56,8 +56,8 @@

\indent {\em virtual int addRecorder(Recorder \&theRecorder);}\\
To add a recorder object {\em theRecorder} to the
SolutionAlgorithm. returns $0$ if successfull, a warning message and a
$-1$ is returned if not enough mempry is available. \\
SolutionAlgorithm. returns $0$ if successful, a warning message and a
$-1$ is returned if not enough memory is available. \\

\indent {\em virtual int record(int track); } \\
To invoke {\em record(track)} on any Recorder objects which have been added to the
Expand All @@ -66,9 +66,3 @@
\indent {\em virtual int playback(int track); } \\
To invoke {\em playback(track)} on any Recorder objects which have been added to the
SolutionAlgorithm. \\






Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
\indent \#include $<\tilde{
}$/analysis/algorithm/domainDecompAlgo/DomainDecompAlgo.h$>$ \\

\noindent {\bf Class Decleration} \\
\noindent {\bf Class Declaration} \\
\indent class DomainDEcompAlgo: public SolutionAlgorithm; \\

\noindent {\bf Class Hierarchy} \\
Expand Down
2 changes: 1 addition & 1 deletion SRC/analysis/algorithm/eigenAlgo/EigenAlgorithm.h
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ class EigenAlgorithm : public SolutionAlgorithm
EigenIntegrator &theIntegrator,
EigenSOE &theSOE);

// pure virtural functions
// pure virtual functions
virtual int solveCurrentStep(int numModes) = 0;
virtual void Print(OPS_Stream &s, int flag=0) = 0;

Expand Down
2 changes: 1 addition & 1 deletion SRC/analysis/algorithm/equiSolnAlgo/AcceleratedNewton.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,7 @@ AcceleratedNewton::solveCurrentStep(void)
return -3;
}

// note - if postive result we are returning what the convergence
// note - if positive result we are returning what the convergence
// test returned which should be the number of iterations
return result;
}
Expand Down
2 changes: 1 addition & 1 deletion SRC/analysis/algorithm/equiSolnAlgo/BFGS.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -388,7 +388,7 @@ BFGS::solveCurrentStep(void)
return -3;
}

// note - if postive result we are returning what the convergence test returned
// note - if positive result we are returning what the convergence test returned
// which should be the number of iterations
return result;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ BisectionLineSearch::search(double s0,
// ---------------
// 2.0

count = 0; //intial value of iteration counter
count = 0; //initial value of iteration counter
while ( r > tolerance && count < maxIter ) {

count++;
Expand Down
2 changes: 1 addition & 1 deletion SRC/analysis/algorithm/equiSolnAlgo/Broyden.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -371,7 +371,7 @@ Broyden::solveCurrentStep(void)
}


// note - if postive result we are returning what the convergence test returned
// note - if positive result we are returning what the convergence test returned
// which should be the number of iterations
return result;
}
Expand Down
2 changes: 1 addition & 1 deletion SRC/analysis/algorithm/equiSolnAlgo/Broyden.h
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@

// Description: This file contains the class definition for
// Broyden. Broyden is a class which performs the Broyden
// solution algorihm in solving the equations.
// solution algorithm in solving the equations.
// No member functions are declared as virtual as
// it is not expected that this class will be subclassed.
//
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ InitialInterpolatedLineSearch::search(double s0,
{
double s = s1;

//intialize r = ratio of residuals
//initialize r = ratio of residuals
double r0 = 0.0;

if ( s0 != 0.0 )
Expand All @@ -90,7 +90,7 @@ InitialInterpolatedLineSearch::search(double s0,

const Vector &dU = theSOE.getX();

int count = 0; //intial value of iteration counter
int count = 0; //initial value of iteration counter

if (printFlag == 0) {
opserr << "InitialInterpolated Line Search - initial "
Expand Down
2 changes: 1 addition & 1 deletion SRC/analysis/algorithm/equiSolnAlgo/KrylovNewton.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ KrylovNewton::solveCurrentStep(void)
return -3;
}

// note - if postive result we are returning what the convergence
// note - if positive result we are returning what the convergence
// test returned which should be the number of iterations
return result;
}
Expand Down
2 changes: 1 addition & 1 deletion SRC/analysis/algorithm/equiSolnAlgo/Linear.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
//

// Description: This file contains the class definition for
// Linear. Linear is a class which performs a linear solution algorihm
// Linear. Linear is a class which performs a linear solution algorithm
// to solve the equations. No member functions are declared as virtual as
// it is not expected that this class will be subclassed.
//
Expand Down
2 changes: 1 addition & 1 deletion SRC/analysis/algorithm/equiSolnAlgo/Linear.h
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
//

// Description: This file contains the class definition for
// Linear. Linear is a class which performs a linear solution algorihm
// Linear. Linear is a class which performs a linear solution algorithm
// to solve the equations. No member functions are declared as virtual as
// it is not expected that this class will be subclassed.
//
Expand Down
2 changes: 1 addition & 1 deletion SRC/analysis/algorithm/equiSolnAlgo/ModifiedNewton.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
//
// Description: This file contains the class definition for
// ModifiedNewton. ModifiedNewton is a class which uses the
// Newton-Raphson solution algorihm
// Newton-Raphson solution algorithm
// to solve the equations. No member functions are declared as virtual as
// it is not expected that this class will be subclassed.
//
Expand Down
2 changes: 1 addition & 1 deletion SRC/analysis/algorithm/equiSolnAlgo/ModifiedNewton.h
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
//
// Description: This file contains the class definition for
// ModifiedNewton. ModifiedNewton is a class which performs a modified
// Newton-Raphson solution algorihm in solving the equations.
// Newton-Raphson solution algorithm in solving the equations.
// No member functions are declared as virtual as
// it is not expected that this class will be subclassed.
//
Expand Down
2 changes: 1 addition & 1 deletion SRC/analysis/algorithm/equiSolnAlgo/NewtonHallM.h
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@

// Description: This file contains the class definition for
// NewtonHallM. NewtonHallM is a class which performs a modified Newton-Raphson-Hall
// solution algorihm in solving the equations
// solution algorithm in solving the equations
//
// What: "@(#)NewtonHallM.h, revA"

Expand Down
4 changes: 2 additions & 2 deletions SRC/analysis/algorithm/equiSolnAlgo/NewtonLineSearch.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ NewtonLineSearch::solveCurrentStep(void)
//line search direction
const Vector &dx0 = theSOE->getX() ;

//intial value of s
//initial value of s
double s0 = - (dx0 ^ Resid0) ;

if (theIntegrator->update(theSOE->getX()) < 0) {
Expand Down Expand Up @@ -177,7 +177,7 @@ NewtonLineSearch::solveCurrentStep(void)
return -3;
}

// note - if postive result we are returning what the convergence test returned
// note - if positive result we are returning what the convergence test returned
// which should be the number of iterations
return result;
}
Expand Down
2 changes: 1 addition & 1 deletion SRC/analysis/algorithm/equiSolnAlgo/NewtonRaphson.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@

// Description: This file contains the class definition for
// NewtonRaphson. NewtonRaphson is a class which uses the
// Newton-Raphson solution algorihm
// Newton-Raphson solution algorithm
// to solve the equations. No member functions are declared as virtual as
// it is not expected that this class will be subclassed.
//
Expand Down
2 changes: 1 addition & 1 deletion SRC/analysis/algorithm/equiSolnAlgo/NewtonRaphson.h
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@

// Description: This file contains the class definition for
// NewtonRaphson. NewtonRaphson is a class which performs a Newton-Raphson
// solution algorihm in solving the equations.
// solution algorithm in solving the equations.
// No member functions are declared as virtual as
// it is not expected that this class will be subclassed.
//
Expand Down
2 changes: 1 addition & 1 deletion SRC/analysis/algorithm/equiSolnAlgo/PeriodicNewton.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
//
// Description: This file contains the class definition for
// PeriodicNewton. PeriodicNewton is a class which uses the
// Newton-Raphson solution algorihm
// Newton-Raphson solution algorithm
// to solve the equations. No member functions are declared as virtual as
// it is not expected that this class will be subclassed.

Expand Down
2 changes: 1 addition & 1 deletion SRC/analysis/algorithm/equiSolnAlgo/PeriodicNewton.h
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
//
// Description: This file contains the class definition for
// PeriodicNewton. PeriodicNewton is a class which performs a Periodic
// Newton-Raphson solution algorihm in solving the equations.
// Newton-Raphson solution algorithm in solving the equations.
// No member functions are declared as virtual as
// it is not expected that this class will be subclassed.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ RegulaFalsiLineSearch::search(double s0,
// ------------------------
// s(l) - s(u)

count = 0; //intial value of iteration counter
count = 0; //initial value of iteration counter
while ( r > tolerance && count < maxIter ) {

count++;
Expand Down
2 changes: 1 addition & 1 deletion SRC/analysis/algorithm/equiSolnAlgo/SecantLineSearch.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ SecantLineSearch::search(double s0,
// ------------------------
// s(j-1) - s(j)

int count = 0; //intial value of iteration counter
int count = 0; //initial value of iteration counter
while ( r > tolerance && count < maxIter ) {

count++;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
** **
** Commercial use of this program without express permission of the **
** University of California, Berkeley, is strictly prohibited. See **
** file 'COPYRIGHT' in main directory for informtion on usage and **
** file 'COPYRIGHT' in main directory for information on usage and **
** redistribution, and for a DISCLAIMER OF ALL WARRANTIES. **
** **
** Developed by: **
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
** **
** Commercial use of this program without express permission of the **
** University of California, Berkeley, is strictly prohibited. See **
** file 'COPYRIGHT' in main directory for informtion on usage and **
** file 'COPYRIGHT' in main directory for information on usage and **
** redistribution, and for a DISCLAIMER OF ALL WARRANTIES. **
** **
** Developed by: **
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
** **
** Commercial use of this program without express permission of the **
** University of California, Berkeley, is strictly prohibited. See **
** file 'COPYRIGHT' in main directory for informtion on usage and **
** file 'COPYRIGHT' in main directory for information on usage and **
** redistribution, and for a DISCLAIMER OF ALL WARRANTIES. **
** **
** Developed by: **
Expand Down
6 changes: 3 additions & 3 deletions SRC/analysis/analysis/DomainDecompositionAnalysis.tex
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
\indent \#include $<\tilde{
}$/analysis/analysis/DomainDecompositionAnalysis.h$>$ \\

\noindent {\bf Class Decleration} \\
\noindent {\bf Class Declaration} \\
\indent class DomainDecompositionAnalysis: public Analysis, public MovableObject; \\

\noindent {\bf Class Hierarchy} \\
Expand Down Expand Up @@ -40,7 +40,7 @@
response values once the solution algorithm has formed and solved the
system of equations.
\item {\bf DomainDecompositionAlgo} - an algorithmic class specifying the
sequence of operations to be performed in determing the response
sequence of operations to be performed in determining the response
for the external dof and placing these in the system of equations.
\item {\bf DomainSolver} - an algorithmic class specifying the
sequence of operations to be performed in performing the numerical
Expand Down Expand Up @@ -159,7 +159,7 @@
formTangent()} is invoked on {\em theIntegrator}, {\em condenseA()} is
invoked on {\em theSolver} object, a flag is set to indicate that the
tangent has been formed, and the {\em counter} is incremented. Returns
a $0$ if successfull, if either the {\em formTangent()} or {\em
a $0$ if successful, if either the {\em formTangent()} or {\em
condenseA()} method returns a negative number this number is
returned. \\

Expand Down
2 changes: 1 addition & 1 deletion SRC/analysis/analysis/DomainUser.tex
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
\noindent {\bf Files} \\
\indent \#include $<$DomainUser.h$>$ \\

\noindent {\bf Class Decleration} \\
\noindent {\bf Class Declaration} \\
\indent class DomainUser; \\

\noindent {\bf Class Hierarchy} \\
Expand Down
2 changes: 1 addition & 1 deletion SRC/analysis/analysis/EigenAnalysis.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
//
// Description: This file contains the class definition of EigenAnalysis.
// EigenAnalysis is a subclass of Analysis, it is used to perform the
// eigen vlaue analysis on the FE_Model.
// eigen value analysis on the FE_Model.
//
// This class is inheritanted from the base class of Analysis
// which was created by fmk (Frank).
Expand Down
2 changes: 1 addition & 1 deletion SRC/analysis/analysis/EigenAnalysis.h
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
//
// Description: This file contains the class definition of EigenAnalysis.
// EigenAnalysis is a subclass of Analysis, it is used to perform the
// eigen vlaue analysis on the FE_Model.
// eigen value analysis on the FE_Model.
//
// This class is inheritanted from the base class of Analysis
// which was created by fmk (Frank).
Expand Down
4 changes: 2 additions & 2 deletions SRC/analysis/analysis/StaticAnalysis.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -440,7 +440,7 @@ StaticAnalysis::domainChanged(void)
return -5;
}

// if get here successfull
// if get here successful
return 0;
}

Expand Down Expand Up @@ -475,7 +475,7 @@ StaticAnalysis::setAlgorithm(EquiSolnAlgo &theNewAlgorithm)

if (theTest != 0)
theAlgorithm->setConvergenceTest(theTest);
else // this else is for backward compatability.
else // this else is for backward compatibility.
theTest = theAlgorithm->getConvergenceTest();

// invoke domainChanged() either indirectly or directly
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -445,7 +445,7 @@ StaticDomainDecompositionAnalysis::domainChanged(void)
return -5;
}

// if get here successfull
// if get here successful
return 0;
}

Expand Down
2 changes: 1 addition & 1 deletion SRC/analysis/analysis/SubstructuringAnalysis.tex
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
\noindent {\bf Files} \\
\indent \#include $<$/analysis/analysis/SubstructuringAnalysis.h$>$ \\

\noindent {\bf Class Decleration} \\
\noindent {\bf Class Declaration} \\
\indent class SubstructuringAnalysis: public DomainDecompositionAnalysis; \\

\noindent {\bf Class Hierarchy} \\
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -428,7 +428,7 @@ TransientDomainDecompositionAnalysis::domainChanged(void)
return -5;
}

// if get here successfull
// if get here successful
return 0;
}

Expand Down
Loading

0 comments on commit 0c3677e

Please sign in to comment.