source: CPL/oasis3-mct/branches/OASIS3-MCT_5.0_branch/doc/doxygen/latex/refman.tex @ 6331

Last change on this file since 6331 was 6331, checked in by aclsce, 17 months ago

Moved oasis-mct_5.0 in oasis3-mct/branches directory.

File size: 6.5 KB
Line 
1\documentclass[twoside]{book}
2
3% Packages required by doxygen
4\usepackage{fixltx2e}
5\usepackage{calc}
6\usepackage{doxygen}
7\usepackage[export]{adjustbox} % also loads graphicx
8\usepackage{graphicx}
9\usepackage[utf8]{inputenc}
10\usepackage{makeidx}
11\usepackage{multicol}
12\usepackage{multirow}
13\PassOptionsToPackage{warn}{textcomp}
14\usepackage{textcomp}
15\usepackage[nointegrals]{wasysym}
16\usepackage[table]{xcolor}
17
18% Font selection
19\usepackage[T1]{fontenc}
20\usepackage[scaled=.90]{helvet}
21\usepackage{courier}
22\usepackage{amssymb}
23\usepackage{sectsty}
24\renewcommand{\familydefault}{\sfdefault}
25\allsectionsfont{%
26  \fontseries{bc}\selectfont%
27  \color{darkgray}%
28}
29\renewcommand{\DoxyLabelFont}{%
30  \fontseries{bc}\selectfont%
31  \color{darkgray}%
32}
33\newcommand{\+}{\discretionary{\mbox{\scriptsize$\hookleftarrow$}}{}{}}
34
35% Page & text layout
36\usepackage{geometry}
37\geometry{%
38  letterpaper,%
39  top=2.5cm,%
40  bottom=2.5cm,%
41  left=2.5cm,%
42  right=2.5cm%
43}
44\tolerance=750
45\hfuzz=15pt
46\hbadness=750
47\setlength{\emergencystretch}{15pt}
48\setlength{\parindent}{0cm}
49\setlength{\parskip}{3ex plus 2ex minus 2ex}
50\makeatletter
51\renewcommand{\paragraph}{%
52  \@startsection{paragraph}{4}{0ex}{-1.0ex}{1.0ex}{%
53    \normalfont\normalsize\bfseries\SS@parafont%
54  }%
55}
56\renewcommand{\subparagraph}{%
57  \@startsection{subparagraph}{5}{0ex}{-1.0ex}{1.0ex}{%
58    \normalfont\normalsize\bfseries\SS@subparafont%
59  }%
60}
61\makeatother
62
63% Headers & footers
64\usepackage{fancyhdr}
65\pagestyle{fancyplain}
66\fancyhead[LE]{\fancyplain{}{\bfseries\thepage}}
67\fancyhead[CE]{\fancyplain{}{}}
68\fancyhead[RE]{\fancyplain{}{\bfseries\leftmark}}
69\fancyhead[LO]{\fancyplain{}{\bfseries\rightmark}}
70\fancyhead[CO]{\fancyplain{}{}}
71\fancyhead[RO]{\fancyplain{}{\bfseries\thepage}}
72\fancyfoot[LE]{\fancyplain{}{}}
73\fancyfoot[CE]{\fancyplain{}{}}
74\fancyfoot[RE]{\fancyplain{}{\bfseries\scriptsize Generated by Doxygen }}
75\fancyfoot[LO]{\fancyplain{}{\bfseries\scriptsize Generated by Doxygen }}
76\fancyfoot[CO]{\fancyplain{}{}}
77\fancyfoot[RO]{\fancyplain{}{}}
78\renewcommand{\footrulewidth}{0.4pt}
79\renewcommand{\chaptermark}[1]{%
80  \markboth{#1}{}%
81}
82\renewcommand{\sectionmark}[1]{%
83  \markright{\thesection\ #1}%
84}
85
86% Indices & bibliography
87\usepackage{natbib}
88\usepackage[titles]{tocloft}
89\setcounter{tocdepth}{3}
90\setcounter{secnumdepth}{5}
91\makeindex
92
93% Hyperlinks (required, but should be loaded last)
94\usepackage{ifpdf}
95\ifpdf
96  \usepackage[pdftex,pagebackref=true]{hyperref}
97\else
98  \usepackage[ps2pdf,pagebackref=true]{hyperref}
99\fi
100\hypersetup{%
101  colorlinks=true,%
102  linkcolor=blue,%
103  citecolor=blue,%
104  unicode%
105}
106
107% Custom commands
108\newcommand{\clearemptydoublepage}{%
109  \newpage{\pagestyle{empty}\cleardoublepage}%
110}
111
112\usepackage{caption}
113\captionsetup{labelsep=space,justification=centering,font={bf},singlelinecheck=off,skip=4pt,position=top}
114
115%===== C O N T E N T S =====
116
117\begin{document}
118
119% Titlepage & ToC
120\hypersetup{pageanchor=false,
121             bookmarksnumbered=true,
122             pdfencoding=unicode
123            }
124\pagenumbering{alph}
125\begin{titlepage}
126\vspace*{7cm}
127\begin{center}%
128{\Large Oasis3-\/\+M\+CT }\\
129\vspace*{1cm}
130{\large Generated by Doxygen 1.8.13}\\
131\end{center}
132\end{titlepage}
133\clearemptydoublepage
134\pagenumbering{roman}
135\tableofcontents
136\clearemptydoublepage
137\pagenumbering{arabic}
138\hypersetup{pageanchor=true}
139
140%--- Begin generated contents ---
141\chapter{Oasis3-\/\+M\+CT Version 4.0\+: June, 2018}
142\label{index}\hypertarget{index}{}\input{index}
143\chapter{Modules Index}
144\input{namespaces}
145\chapter{Data Type Index}
146\input{annotated}
147\chapter{File Index}
148\input{files}
149\chapter{Module Documentation}
150\input{namespacemod__oasis}
151\input{namespacemod__oasis__advance}
152\input{namespacemod__oasis__auxiliary__routines}
153\input{namespacemod__oasis__coupler}
154\input{namespacemod__oasis__data}
155\input{namespacemod__oasis__getput__interface}
156\input{namespacemod__oasis__grid}
157\input{namespacemod__oasis__io}
158\input{namespacemod__oasis__ioshr}
159\input{namespacemod__oasis__kinds}
160\input{namespacemod__oasis__map}
161\input{namespacemod__oasis__mem}
162\input{namespacemod__oasis__method}
163\input{namespacemod__oasis__mpi}
164\input{namespacemod__oasis__namcouple}
165\input{namespacemod__oasis__parameters}
166\input{namespacemod__oasis__part}
167\input{namespacemod__oasis__reprosum}
168\input{namespacemod__oasis__string}
169\input{namespacemod__oasis__sys}
170\input{namespacemod__oasis__timer}
171\input{namespacemod__oasis__var}
172\input{namespacemod__prism}
173\chapter{Data Type Documentation}
174\input{interfacemod__oasis__getput__interface_1_1oasis__get}
175\input{interfacemod__oasis__mpi_1_1oasis__mpi__bcast}
176\input{interfacemod__oasis__mpi_1_1oasis__mpi__gatherv}
177\input{interfacemod__oasis__mpi_1_1oasis__mpi__gathscatvinit}
178\input{interfacemod__oasis__mpi_1_1oasis__mpi__max}
179\input{interfacemod__oasis__mpi_1_1oasis__mpi__min}
180\input{interfacemod__oasis__mpi_1_1oasis__mpi__recv}
181\input{interfacemod__oasis__mpi_1_1oasis__mpi__scatterv}
182\input{interfacemod__oasis__mpi_1_1oasis__mpi__send}
183\input{interfacemod__oasis__mpi_1_1oasis__mpi__sum}
184\input{interfacemod__oasis__getput__interface_1_1oasis__put}
185\input{interfacemod__oasis__grid_1_1oasis__write__angle}
186\input{interfacemod__oasis__grid_1_1oasis__write__area}
187\input{interfacemod__oasis__grid_1_1oasis__write__corner}
188\input{interfacemod__oasis__grid_1_1oasis__write__grid}
189\input{structmod__oasis__coupler_1_1prism__coupler__type}
190\input{structmod__oasis__grid_1_1prism__grid__type}
191\input{structmod__oasis__map_1_1prism__mapper__type}
192\input{structmod__oasis__part_1_1prism__part__type}
193\input{structmod__oasis__coupler_1_1prism__router__type}
194\input{structmod__oasis__var_1_1prism__var__type}
195\input{structmod__oasis__timer_1_1timer__details}
196\chapter{File Documentation}
197\input{oasis__os_8h}
198\input{mod__oasis_8_f90}
199\input{mod__oasis__advance_8_f90}
200\input{mod__oasis__auxiliary__routines_8_f90}
201\input{mod__oasis__coupler_8_f90}
202\input{mod__oasis__data_8_f90}
203\input{mod__oasis__getput__interface_8_f90}
204\input{mod__oasis__grid_8_f90}
205\input{mod__oasis__io_8_f90}
206\input{mod__oasis__ioshr_8_f90}
207\input{mod__oasis__kinds_8_f90}
208\input{mod__oasis__map_8_f90}
209\input{mod__oasis__mem_8_f90}
210\input{mod__oasis__method_8_f90}
211\input{mod__oasis__mpi_8_f90}
212\input{mod__oasis__namcouple_8_f90}
213\input{mod__oasis__parameters_8_f90}
214\input{mod__oasis__part_8_f90}
215\input{mod__oasis__reprosum_8_f90}
216\input{mod__oasis__string_8_f90}
217\input{mod__oasis__sys_8_f90}
218\input{mod__oasis__timer_8_f90}
219\input{mod__oasis__var_8_f90}
220\input{mod__prism_8_f90}
221%--- End generated contents ---
222
223% Index
224\backmatter
225\newpage
226\phantomsection
227\clearemptydoublepage
228\addcontentsline{toc}{chapter}{Index}
229\printindex
230
231\end{document}
Note: See TracBrowser for help on using the repository browser.