Commit da3e2fa7 authored by Turnhout, M.C. van's avatar Turnhout, M.C. van
Browse files

start documenting engine output

parent b74a361b
......@@ -20,11 +20,39 @@ These scripts do the actually \textsl{work}, we do not call them the `engine' w
\begin{enumerate}
\item[$\mat{M}$] the (global) `mass' matrix for the final linear set of equations, for time-dependent problems
\item[$\mat{C}$] the (global) `damping' or `convective' matrix for the final linear set of equations, for first derivative terms in the PDE
\item[$\mat{K}$] the (global) `mass' matrix for the final linear set of equations, for second derivative terms in the PDE
\item[$\mat{K}$] the (global) `stiffness' matrix for the final linear set of equations, for second derivative terms in the PDE
\item[$\col{u}$] the (global) column with the degrees of freedom
\item[$\col{f}$] the (global) right-hand-side array for the final linear set of equations
\end{enumerate}
These global matrices are assembled from the corresponding element matrices (i.e.\ $\mat{K}$ is assembled from $\mat{K}_\mathrm{e}$, etc.). See the element documentation (appendix \ref{elmlib}) for the specifics of the element matrices for each element.
These global matrices are assembled from the corresponding element matrices (i.e.\ $\mat{K}$ is assembled from $\mat{K}_\mathrm{e}$, etc.) and are available for linear engines after the solution \kwo{sol} has been calculated (table \ref{enginevar}, see the element documentation in appendix \ref{elmlib} for the specifics of the element matrices for each element).
\begin{table}[h]
\center
\caption{Variables filled (overwritten) by the engines. \label{enginevar}}
\begin{tabular}{l c c c c c l l }
\hline\noalign{\smallskip}
engine & $\mat{M}$ & $\mat{K}$ & $\mat{C}$ & $\col{f}$ & $\col{u}$ & $\sigma$ & and\dots\\
\noalign{\smallskip}\hline\noalign{\bigskip}
\kwc{fem1d} & & \kwo{K} & & \kwo{rhs} & \kwo{sol} & \texttt{sigma} &\kwo{pos}, \kwo{dest}\\
\kwc{fem1dcd} & \kwo{M} & \kwo{K} & \kwo{C} & \kwo{rhs} & \kwo{sol}, \kwo{soln} & & \kwo{pos}, \kwo{dest}, \kwo{q}\\
\kwc{femlin\_cd} & \kwo{M} & \kwo{K} & \kwo{C} & \kwo{rhs} & \kwo{sol}, \kwo{soln} && \kwo{pos}, \kwo{dest}, \kwo{q}\\
\kwc{femlin\_e} & & \kwo{K} & & \kwo{rhs} & \kwo{sol} & \texttt{sigma\_elm} & \kwo{pos}, \kwo{dest}\\
\kwc{femnl} & & & & \kwo{rhs} & \kwo{sol}, \kwo{solinc} && \kwo{pos}, \kwo{dest}\\
\kwc{femnlt} & & & & \kwo{rhs} & \kwo{sol}, \kwo{soln} && \kwo{pos}, \kwo{dest}\\
\noalign{\smallskip}\hline
\end{tabular}
\end{table}
The matrix \kwo{q} equals
\begin{lstlisting}[language=mlfem,numbers=none]
q = K + C;
\end{lstlisting}
for stationary convection-diffusion problems, and
\begin{lstlisting}[language=mlfem,numbers=none]
q = M/dt + theta*C + theta*K;
\end{lstlisting}
for time-dependent convection-diffusion problems.
\section{1D diffusion problems: \kwc{fem1d}}\label{enginefem1d}
......
......@@ -6,7 +6,7 @@ morekeywords = {clearvars,function,end,unique,numel},
classoffset=1,
morekeywords={coord, top, pos, dest, nodfrc, bndcnd,inode,ielem,maxnodelm,iimat,iitype, mat,types,idof,ibnd,bndcon,nodfrc,sol,points,curves,subarea,usercurves,userpoints,
usersurfaces,itime,norder,istat,ntime,dt,theta,ietype, nincr, newtoptions,solinc,itype,
Ke, Me, Ce, rhse, soln},
Ke, Me, Ce, rhse, K,M,C,q,rhs,soln},
keywordstyle=\color{orange},
classoffset=2,
morekeywords={startup_nac,
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment