diff --git a/documentation/Manual/MPIE_CPFEM_manual.pdf b/documentation/Manual/MPIE_CPFEM_manual.pdf index 6563127a0..57c63f9c3 100644 Binary files a/documentation/Manual/MPIE_CPFEM_manual.pdf and b/documentation/Manual/MPIE_CPFEM_manual.pdf differ diff --git a/documentation/Manual/MPIE_CPFEM_manual.tex b/documentation/Manual/MPIE_CPFEM_manual.tex index c2484cb02..7351775f0 100644 --- a/documentation/Manual/MPIE_CPFEM_manual.tex +++ b/documentation/Manual/MPIE_CPFEM_manual.tex @@ -19,7 +19,7 @@ breaklinks=true,% \hypersetup{ pdfauthor = {Claudio Zambaldi, Philip Eisenlohr}, -pdftitle = {Manual to the Crystal Plasticity Finite Element Subroutine developed at the Max-Planck-Institut f\"ur Eisenforschung}, +pdftitle = {Manual to the Material Point Model developed at the Max-Planck-Institut f\"ur Eisenforschung}, pdfsubject = {}, pdfkeywords = {}, pdfcreator = {}, @@ -31,7 +31,8 @@ pdfproducer = {pdftex}%, \usepackage{amsmath,amssymb,amsfonts} \usepackage{bm} \usepackage{miller} -\usepackage[alsoload={accepted,named,prefix}]{siunitx} +%\usepackage[alsoload={accepted,named,prefix}]{siunitx} +\usepackage{siunitx} \usepackage{booktabs} \usepackage{longtable} \usepackage[indent,bf,tableposition=top]{caption} % Einstellen des caption-Stils, war caption2 @@ -40,12 +41,18 @@ pdfproducer = {pdftex}%, \usepackage[bookman]{quotchap} \usepackage{csquotes} % consistent quoting by \enquote{...} \usepackage{listings} -\lstloadlanguages{fortran} +%\lstloadlanguages{bash,fortran} \lstset{language={}, - frame=none, - xleftmargin=10mm, - xrightmargin=10mm, - numbers=left, + lineskip=4pt, + frame=none, + framesep=0mm, + framexleftmargin=5mm, + framexrightmargin=5mm, + framextopmargin=5mm, + framexbottommargin=5mm, + xleftmargin=10mm, + xrightmargin=10mm, +% numbers=left, stepnumber=1, numbersep=5pt, numberstyle=\tiny, @@ -88,11 +95,11 @@ pdfproducer = {pdftex}%, \newcommand{\tnsr}[1]{\ensuremath{\bm{#1}}} \newcommand{\vctr}[1]{\ensuremath{\bm{#1}}} -\newcommand{\drv}{\ensuremath{\mathrm d}} +\newcommand{\inc}{\ensuremath{\mathrm d}} -\newcommand{\transpose}[1]{\ensuremath{{#1}^{\mathrm T}}} +\newcommand{\transpose}[1]{\ensuremath{{#1}^{\text T}}} \newcommand{\inverse}[1]{\ensuremath{{#1}^{-1}}} -\newcommand{\invtranspose}[1]{\ensuremath{{#1}^{\mathrm{-T}}}} +\newcommand{\invtranspose}[1]{\ensuremath{{#1}^{\text{-T}}}} \newcommand{\eyetwo}{\ensuremath{\tnsr{I}}} \newcommand{\eyefour}{\ensuremath{\mathbb{I}}} @@ -176,11 +183,9 @@ Cited% %\else %times% %\fi -~on % -\ifnum#1=1 % -page% -\else -pages% +~on page% +\ifnum#1>1 % +s% \fi ~#2% .% @@ -189,7 +194,7 @@ pages% \begin{document} -\title{Manual\\[1cm]\LARGE to the \\[3mm] Crystal Plasticity Finite Element Subroutine \\[3mm] developed at the \\[3mm] Max-Planck-Institut f\"ur Eisenforschung} +\title{Manual\\[1cm]Material Point Model \\[3mm] \normalsize developed at the \\[3mm] Max-Planck-Institut f\"ur Eisenforschung} \author{Claudio Zambaldi \and Philip Eisenlohr} \maketitle @@ -206,7 +211,10 @@ pages% \renewcommand{\chaptermark}[1]{\markboth{{\thechapter\ \ #1}}{}} \input{include/Preliminaries} +\part{Praxis} +%\input{include/Installation} \input{include/CodeOrganization} +\part{Theory} \input{include/Homogenization} \input{include/ConstitutiveLaws} \input{include/ApplicationNotes} diff --git a/documentation/Manual/include/CodeOrganization.tex b/documentation/Manual/include/CodeOrganization.tex index 952db0a19..47ce345d5 100644 --- a/documentation/Manual/include/CodeOrganization.tex +++ b/documentation/Manual/include/CodeOrganization.tex @@ -2,11 +2,8 @@ \chapter{Organization of the code} % ################# - -\begin{figure} -\centering -\includegraphics[width=0.80\textwidth]{crystallite_updateState} -\caption{updateState} -\label{fig:crystallite_updateState} -\end{figure} - +\input{include/org_code} +\input{include/org_documentation} +\input{include/org_processing} +\input{include/org_testing} +\input{include/org_installation} diff --git a/documentation/Manual/include/svn_guide.tex b/documentation/Manual/include/svn_guide.tex index 614f788d9..32bf777d1 100644 --- a/documentation/Manual/include/svn_guide.tex +++ b/documentation/Manual/include/svn_guide.tex @@ -1,37 +1,53 @@ -\section{Accessing the version controlled subroutine} +\section{Internal access to the version-controlled sources} % This section is copied from the msuwiki: http://msusrv4/msuwiki/Theory%20and%20Simulation/SVN -Before you start: Before you are able to access the version-controlled software, you need to get a valid login to the msuhp9 server. Please ask either Berthold Becksch\"afer (-922) or Achim Kuhl (-923) to set up your permissions accordingly. +A prerequisite for you being able to access the version-controlled software is to +\begin{enumerate} +\item valid login +\item membership in the \verb|svn| group on server \verb|musvn1| +\end{enumerate} +Please ask either Berthold Becksch\"afer (-922) or Achim Kuhl (-923) to set up your permissions accordingly. \subsection{Windows} \subsubsection{Putty} -Get yourself PuTTY and PuTTYgen from http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html -Generate a RSA (SSH2) 2048 bit strong key pair with PuTTYgen. Save the private part of the key to a secure location (My Documents or such). Copy the public part from the PuTTYgen window, paste it into a text-editor and save. Append the contents of that file to \verb|~/.ssh/authorized_keys| on any workstation you can log on to. -Create a profile in PuTTY called "msuhp9" with host: msuhp9.mpie.de, your standard "MPIE\\myName" username and specify the above location of your private key file as means of authentication. -You should then be able to connect with this profile to msuhp9 WITHOUT password authentication! +Get yourself \verb|PuTTY| and \verb|PuTTYgen| from \url{http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html}. +Generate a RSA (SSH2) 2048 bit strong key pair with \verb|PuTTYgen|. +Save the private part of the key to a secure location (\verb|My Documents| or such). +Copy the public part from the \verb|PuTTYgen| window, paste it into a text-editor and save. +Append the contents of that file to \verb|~/.ssh/authorized_keys| on any workstation you can log on to. +Create a profile in \verb|PuTTY| called "\verb|musvn1|" with host \verb|musvn1.mpie.de|, your standard "\verb|MPIE\\myName|" username and specify the above location of your private key file as means of authentication. +You should then be able to connect with this profile to \verb|musvn1| WITHOUT password authentication! \subsubsection{Tortoise} -Install the subversion-client Tortoise at http://tortoisesvn.net/downloads -Create a directory to hold the CPFEM subroutine on your PC. - -Right-Click in this folder and select "SVN checkout" from the context menu. Specify -svn+ssh://msuhp9/home/svn/repos/cpfem - -as the URL of the desired repository. This will use the profile named "msuhp9" from PuTTY and should hence not ask for any authentication from your end. +Install the subversion-client Tortoise from \url{http://tortoisesvn.net/downloads}. +Create a directory to hold the Material Point Model subroutine on your PC. +Right-click in this folder and select "SVN checkout" from the context menu. +Specify \url{svn+ssh://musvn1/home/svn/repos/cpfem} as the URL of the desired repository. +This will use the profile named "\verb|musvn1|" from \verb|PuTTY| and should hence not ask for any authentication from your end. \subsection{Linux workstations} \subsubsection{Key authentication} -if not already done, generate a 2048 bit RSA key pair using -ssh-keygen -t rsa -b 2048 -and go for the standard options offered. This will create "id\_rsa" (private key) and "id\_rsa.pub" (public key) within your \verb|~/.ssh| folder. - -Append \verb|id_rsa.pub| to \verb|~/.ssh/authorized_keys| and try logging into another workstation with -ssh MPIE\\\\myName@msuwsX -(exchange X with 2...11). It should NOT require password authentication. +If not already done, generate a 2048 bit RSA key pair using +\begin{lstlisting}[language=bash] +ssh-keygen -t rsa -b 2048 +\end{lstlisting} +and go for the standard options offered. +This will create "\verb|id_rsa|" (private key) and "\verb|id_rsa.pub|" (public key) within your \verb|~/.ssh| folder. +Append the public key to the list of known keys +\begin{lstlisting}[language=bash] +cat ~/.ssh/id_rsa.pub >> ~/.ssh/authorized_keys +\end{lstlisting} +and try logging into another workstation with +\begin{lstlisting}[language=bash] +ssh msuwsX +\end{lstlisting} + (exchange X with $1\dots 13$). +It should \emph{not} require password authentication. \subsubsection{Checkout} -create a directory to hold the subversion-controlled CPFEM routine and change into this. -svn checkout svn+ssh://MPIE\\\\myName@msuhp9.mpie.de/home/svn/repos/cpfem -to copy the repository content to the current working directory -- done. - -familiarize yourself with svn: svn help \ No newline at end of file +Create a directory to hold the subversion-controlled Material Point Model routine and change into this. +Issue the command +\begin{lstlisting}[language=bash] +svn co svn+ssh://MPIE\\yourName@musvn1/home/svn/repos/cpfem +\end{lstlisting} +to copy the repository content to the current working directory.