223031012
/
DAMASK_EICMD
mirror of https://github.com/achalhp/DAMASK_EICMD.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

first shot at reviving the manual...

This commit is contained in:
Philip Eisenlohr 2011-03-11 08:43:29 +00:00
parent 621c1198a4
commit d860015d57
4 changed files with 70 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
documentation/Manual/MPIE_CPFEM_manual.pdf
View File

Binary file not shown.

40
documentation/Manual/MPIE_CPFEM_manual.tex
View File

@ -19,7 +19,7 @@ breaklinks=true,%
\hypersetup{ \hypersetup{
pdfauthor = {Claudio Zambaldi, Philip Eisenlohr}, 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 = {}, pdfsubject = {},
pdfkeywords = {}, pdfkeywords = {},
pdfcreator = {}, pdfcreator = {},
@ -31,7 +31,8 @@ pdfproducer = {pdftex}%,
\usepackage{amsmath,amssymb,amsfonts} \usepackage{amsmath,amssymb,amsfonts}
\usepackage{bm} \usepackage{bm}
\usepackage{miller} \usepackage{miller}
\usepackage[alsoload={accepted,named,prefix}]{siunitx} %\usepackage[alsoload={accepted,named,prefix}]{siunitx}
\usepackage{siunitx}
\usepackage{booktabs} \usepackage{booktabs}
\usepackage{longtable} \usepackage{longtable}
\usepackage[indent,bf,tableposition=top]{caption} % Einstellen des caption-Stils, war caption2 \usepackage[indent,bf,tableposition=top]{caption} % Einstellen des caption-Stils, war caption2
@ -40,12 +41,18 @@ pdfproducer = {pdftex}%,
\usepackage[bookman]{quotchap} \usepackage[bookman]{quotchap}
\usepackage{csquotes} % consistent quoting by \enquote{...} \usepackage{csquotes} % consistent quoting by \enquote{...}
\usepackage{listings} \usepackage{listings}
\lstloadlanguages{fortran} %\lstloadlanguages{bash,fortran}
\lstset{language={}, \lstset{language={},
frame=none, lineskip=4pt,
xleftmargin=10mm, frame=none,
xrightmargin=10mm, framesep=0mm,
numbers=left, framexleftmargin=5mm,
framexrightmargin=5mm,
framextopmargin=5mm,
framexbottommargin=5mm,
xleftmargin=10mm,
xrightmargin=10mm,
% numbers=left,
stepnumber=1, stepnumber=1,
numbersep=5pt, numbersep=5pt,
numberstyle=\tiny, numberstyle=\tiny,
@ -88,11 +95,11 @@ pdfproducer = {pdftex}%,
\newcommand{\tnsr}[1]{\ensuremath{\bm{#1}}} \newcommand{\tnsr}[1]{\ensuremath{\bm{#1}}}
\newcommand{\vctr}[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{\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{\eyetwo}{\ensuremath{\tnsr{I}}}
\newcommand{\eyefour}{\ensuremath{\mathbb{I}}} \newcommand{\eyefour}{\ensuremath{\mathbb{I}}}
@ -176,11 +183,9 @@ Cited%
%\else %\else
%times% %times%
%\fi %\fi
~on % ~on page%
\ifnum#1=1 % \ifnum#1>1 %
page% s%
\else
pages%
\fi \fi
~#2% ~#2%
.% .%
@ -189,7 +194,7 @@ pages%
\begin{document} \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} \author{Claudio Zambaldi \and Philip Eisenlohr}
\maketitle \maketitle
@ -206,7 +211,10 @@ pages%
\renewcommand{\chaptermark}[1]{\markboth{{\thechapter\ \ #1}}{}} \renewcommand{\chaptermark}[1]{\markboth{{\thechapter\ \ #1}}{}}
\input{include/Preliminaries} \input{include/Preliminaries}
\part{Praxis}
%\input{include/Installation}
\input{include/CodeOrganization} \input{include/CodeOrganization}
\part{Theory}
\input{include/Homogenization} \input{include/Homogenization}
\input{include/ConstitutiveLaws} \input{include/ConstitutiveLaws}
\input{include/ApplicationNotes} \input{include/ApplicationNotes}

13
documentation/Manual/include/CodeOrganization.tex
View File

@ -2,11 +2,8 @@
\chapter{Organization of the code} \chapter{Organization of the code}
% ################# % #################
\input{include/org_code}
\begin{figure} \input{include/org_documentation}
\centering \input{include/org_processing}
\includegraphics[width=0.80\textwidth]{crystallite_updateState} \input{include/org_testing}
\caption{updateState} \input{include/org_installation}
\label{fig:crystallite_updateState}
\end{figure}

66
documentation/Manual/include/svn_guide.tex
View File

@ -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 % 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} \subsection{Windows}
\subsubsection{Putty} \subsubsection{Putty}
Get yourself PuTTY and PuTTYgen from http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html 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 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. Generate a RSA (SSH2) 2048 bit strong key pair with \verb|PuTTYgen|.
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. Save the private part of the key to a secure location (\verb|My Documents| or such).
You should then be able to connect with this profile to msuhp9 WITHOUT password authentication! 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} \subsubsection{Tortoise}
Install the subversion-client Tortoise at http://tortoisesvn.net/downloads Install the subversion-client Tortoise from \url{http://tortoisesvn.net/downloads}.
Create a directory to hold the CPFEM subroutine on your PC. 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.
Right-Click in this folder and select "SVN checkout" from the context menu. Specify Specify \url{svn+ssh://musvn1/home/svn/repos/cpfem} as the URL of the desired repository.
svn+ssh://msuhp9/home/svn/repos/cpfem This will use the profile named "\verb|musvn1|" from \verb|PuTTY| and should hence not ask for any authentication from your end.
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.
\subsection{Linux workstations} \subsection{Linux workstations}
\subsubsection{Key authentication} \subsubsection{Key authentication}
if not already done, generate a 2048 bit RSA key pair using If not already done, generate a 2048 bit RSA key pair using
ssh-keygen -t rsa -b 2048 \begin{lstlisting}[language=bash]
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. ssh-keygen -t rsa -b 2048
\end{lstlisting}
Append \verb|id_rsa.pub| to \verb|~/.ssh/authorized_keys| and try logging into another workstation with and go for the standard options offered.
ssh MPIE\\\\myName@msuwsX This will create "\verb|id_rsa|" (private key) and "\verb|id_rsa.pub|" (public key) within your \verb|~/.ssh| folder.
(exchange X with 2...11). It should NOT require password authentication. 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} \subsubsection{Checkout}
create a directory to hold the subversion-controlled CPFEM routine and change into this. Create a directory to hold the subversion-controlled Material Point Model routine and change into this.
svn checkout svn+ssh://MPIE\\\\myName@msuhp9.mpie.de/home/svn/repos/cpfem Issue the command
to copy the repository content to the current working directory -- done. \begin{lstlisting}[language=bash]
svn co svn+ssh://MPIE\\yourName@musvn1/home/svn/repos/cpfem
familiarize yourself with svn: svn help \end{lstlisting}
to copy the repository content to the current working directory.