path: root/Master/texmf-dist/doc/latex/asmeconf/asmeconf-template.tex

%% 
%%  This file is ASMEconf-class-template.tex, a template for ASME Conference papers according to
%%  ASME conference requirements as represented on ASME's conference web pages in March 2019.
%%  (NB: ASME's journals follow specifications different from ASME conference papers.)
%%
%%  This file is version 1.0 dated 2019/03/28
%%
%%  Author: John H. Lienhard V
%%          Department of Mechanical Engineering
%%          Massachusetts Institute of Technology
%%          Cambridge, MA 02139-4307 USA
%%
%%  Several new commands are defined by the asmeconf class; their use is illustrated below.
%%  In particular, ASME requires capitalized, sans-serif section headings, and as a result some care  
%%  is needed when using some macros in section headings, as also illustrated below.
%%
%%  Class options are described in the asmeconf.cls file. These include:
%%          * math options from M. Sharpe's newtxmath package: upright integrals [upint]; and
%%          *    varvw for a v and w that are better distinguished from greek nu; and also 
%%          *    smallerops, varg, slantedGreek, frenchmath, varbb, cmbraces
%%          * many options for calligraphic, script, and fraktur fonts from the mathalfa package; the
%%          *    default values are: scr=dutchcal,cal=euler
%%          * option to omit ASME copyright footer: nofoot
%%          * option not to use newtxtext's superiors font for footnotes [nodefaultsups] and option
%%          *    for slightly larger small capitals, largesc
%%
%%  For details of newtxmath and mathalfa, see their documentation (available on CTAN: http://ctan.org)
%%
 %=========================================================
%% LICENSE:
%%
%% Copyright (c) 2019 John Lienhard
%%
%% Permission is hereby granted, free of charge, to any person obtaining a copy of this software and 
%% associated documentation files (the "Software"), to deal in the Software without restriction, 
%% including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, 
%% and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, 
%% subject to the following conditions:
%%
%% The above copyright notice and this permission notice shall be included in all copies or 
%% substantial portions of the Software.
%%
%% THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT 
%% NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 
%% IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, 
%% WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE 
%% SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%



%% Class options are described above
\documentclass[varvw,largesc,upint]{asmeconf}


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% Editing tools, can delete if not using them

\usepackage{lipsum}  % Generates paragraphs of gibberish latin for checking layout ... e.g. \lipsum[2-4] produces
                     % paragraphs 2 through 4 of the text.
\usepackage{comment} % for commenting out passages.  See package documentation for usage.

%% Filler names for Author and affiliation blocks on title page
\def\AuthorName{Name[s] of Author[s]}
\long\def\Affiliation{Department of Mechanical Engineering\\
   Institution or Company Name\\
   Street address\\
   City, State, Country}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%   Fields to be completed %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

%%%%%  pdf metadata and colors   %%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%  The user should edit as desired  %%%%%%%%%%%%

\hypersetup{%
	colorlinks=true,%%% <=== change to false to get black type for links (ASME sometimes requests this)
	linkcolor=blue, %
	citecolor=blue, % SeaGreen4,
	urlcolor=blue,  % Red3,
	pdftitle={ASME Conference Paper Template},    % <=== add your pdf file title
	pdfkeywords={ASME, Paper, Template, \LaTeX, Research}, % <=== add your pdf keywords
	pdfauthor={John H. Lienhard},  % <=== change this to YOUR name[s]!!!
}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\begin{document}

% Change these fields to the right content for your conference!
% You can comment these out if for some reason you don't want a header.

\ConfName{Proceedings of the ASME 2018 \linebreak International Mechanical Engineering Congress and Exposition}
\ConfAcronym{IMECE18}
\ConfDate{November 9-15, 2018}
\ConfCity{Pittsburgh, PA, USA}
\PaperNo{IMECE2018-XXXX}

\PaperTitle{Our research paper: the latest developments in cutting-edge engineering}
 
% Change to your name[s] and addresses,in the desired order of authors. Up to nine author blocks.
% Note usage for joint first authors and for corresponding author.

\SetAuthorBlock{Luis Hern\'{a}ndez\JointFirstAuthor}{\Affiliation} 
\SetAuthorBlock{Maria Silva\JointFirstAuthor}{\Affiliation}

\SetAuthorBlock{Henry Tudor,  Catherine Parr}{Hampton Court Palace \\ Richmond, England}
\SetAuthorBlock{Jinsoo Kim}{\Affiliation}
\SetAuthorBlock{Yusuf Yilmaz}{\Affiliation}
%\SetAuthorBlock{Amelia Smith}{\Affiliation}
%\SetAuthorBlock{Aadhya Acharya}{\Affiliation}
%\SetAuthorBlock{Omar Abu Bakr}{\Affiliation}

\SetAuthorBlock{\CorrespondingAuthor{John H.\ Lienhard V}{lienhard@mit.edu}}{%
Rohsenow Kendall Heat Transfer Lab \\ Department of Mechanical Engineering
\\ Massachusetts Institute of Technology \\ Cambridge, MA 02139 USA}

\MakeTitlePage


%%% Change these to your keywords.  Keywords are automatically printed at the end of the abstract.
%%% This command must come BEFORE the end of the abstract.
%%%    If you don't want keywords, delete the command.

\keywords{ASME, Paper, Template, \LaTeX, Research}

%%%%%%%%%%%%%%%%%%%%%  End of fields to be completed. Now write! %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%


\begin{abstract}
This paper is an example and template for the \texttt{asmeconf} class. Papers typeset in this class will follow ASME Conference guidelines for margins, fonts, headings, captions, and reference formats. Standard \LaTeX\ commands are used. The class is compatible with the \texttt{hyperref} package.  The class defines new environments for abstract and nomenclature. The optional argument of \verb|\section| has been modified for manually setting pdf bookmarks when macros or complicated mathematics are included in section headings. The class is intended to be used with the \texttt{asmeconf.bst} \textsc{Bib}\negthinspace\TeX\ style, which is part of this distribution. The class may be invoked with several options, most of which address math fonts. The class is based on a number of packages, all of which are in \TeX\textsc{live}\ and on CTAN (\href{http://ctan.org}{ctan.org}).
\end{abstract}


\section*{Introduction}
For ASME conference papers, the labels Figure and Equation should be abbreviated when they do not start a sentence, as in Fig.~\ref{fig:1} and Eq.~\eqref{eqn:dw}. Figure~\ref{fig:1} is spelled out when it starts a sentence. Equation~\eqref{eqn:dw} is spelled out when it starts a sentence. 

References are automatically numbered \cite{ning2002}. They should be inserted at the appropriate point using a \verb|\cite{ref}| command~\cite{gibson2008,stevens1999}. The references will be automatically sorted and compressed as well if they are given in a set \cite{stevens1999,ning2002,gibson2008,wions2005,smith2002,watson1982,smith1998}. See the \texttt{asmeconf-sample.bib} file for examples of how to enter your references.

Equations are typeset in the usual way.  The class file loads the \texttt{amsmath} and \texttt{mathtools} packages. Further, the \texttt{newtxmath} package used for the math fonts includes many additional features.
\begin{equation}\label{eqn:fourier}
\vec{q} = -k\nabla T
\end{equation}
ASME does not specify a standard nomenclature list. Be sure to put your symbols into the nomenclature list, including SI units.


\subsection*{Section headings and captions}
ASME requires that section headings and captions be set in an uppercase, bold face, sans serif font.  The class will do this automatically.  You can place \verb|\cite{..}|, \verb|\ref{..}|, \verb|\label{..}|, and into headings and captions directly, as you would in the main text. Do not enclose them braces, e.g.\ \verb|{\cite{..}}|, which will cause errors. You can place \verb|\footnote{..}| into headings, but not into captions.\footnote{See \texttt{tex-stackexchange} for various approaches to footnotes in captions, if you really want to have them.}

Simple math can be used in either captions or section headings, but see the \texttt{asmeconf.tex} source file for examples of how to deal with more complicated expressions.

To get bold math, you can use the \verb|\bm{..}| macro from the \texttt{bm} package, which is loaded by the class. To get sans serif math, you can use \verb|\mathsf{..}|. So, you can write \verb|\bm{\mathsf{A+B}}| to put a bold, sans serif expression in a caption. The class file provides for sans serif greek letters by using \verb|\sfalpha| and similar expressions (e.g.\ $\sfalpha, \sfbeta, \sfgamma, \sfdelta \ldots$) for use in captions and headings (see Fig.\ \ref{fig:1}).

For a section heading that includes more complicated math (and macros), you may use the optional argument of \verb|\section[..]{..}| to create a pdf bookmark without losing characters or producing warnings or errors. See the \texttt{asmeconf.tex} source file for examples of this. These bookmarks should usually be text expressions, although some math is supported.  

Text in section headings and captions will not be capitalized if enclosed in a \verb|\NoCaseChange{...}| command. 

\subsubsection*{Latin for layout}
The rest of this text uses Latin to show layout and usage. Refer to the \texttt{.tex} file for further details. \lipsum[4-5] %%% This command generates paragraphs of fake Latin.  Delete it here and elsewhere!

%%%%%%%%%%%%% begin figure %%%%%%%%%%%%%%%%%

\begin{figure}
\centering\includegraphics[width=0.7\linewidth]{sample-figure-1.pdf}
\caption{A figure caption with math, $\bm{\mathsf{z = (r,\sfphi)}}$ \cite{Lienhard2019b}\label{fig:1}}
%% note: \upphi is upright \phi under the newtxmath package used here. 
\end{figure}
 
%%%%%%%%%%%%% end figure %%%%%%%%%%%%%%%%%%%


%% Dealing with complicated math in a section heading: optional argument provides the pdfbookmark
%% without losing characters or producing warnings/errors.
\section*[Math in a section heading: a=0]{Math in a section heading: $\bm{\vec{\mathsf{a}}=\mathsf{0}}$}

\lipsum[6-7] %%% This command generates paragraphs of fake Latin.  Delete it here and elsewhere!


%%%%%%%%%%%%%%% begin simple table %%%%%%%%%%%%%%%%%%%%%%%%%% 
 
\begin{table}[t]
\caption[Table]{A simple table\label{tab:1}}
\centering{%
\begin{tabular}{l l r}
\toprule
Experiment & $u$ [m/s] & $T$ [\textdegree C] \\
\midrule
Run 11 & 12.5 & 103.4 \\
Run 12 & 24   & 68.3 \\
\bottomrule
\end{tabular}
}
\end{table}

%%%%%%%%%%%%%%%% end table  %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 


%%%%%%%%%%%%%%% begin more complicated table %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
\begin{table}[t]
\caption{Table with more complicated columns}\label{tab:2}%
\centering{%
\begin{tabular}{!{\hspace*{0.5cm}} >{\raggedright\hangindent=1em} p{3cm} d{3} @{\hspace*{1cm}} d{3} !{\hspace*{0.5cm}}}
\toprule
Experiment & \multicolumn{1}{c@{\hspace*{1cm}}}{$u$ [m/s]} & \multicolumn{1}{c!{\hspace*{0.5cm}}}{$T$ [\textdegree C]} \\
\midrule
The first test we ran this morning   & 124.3     &   68.3   \\
The second test we ran this morning  &  82.50    &  103.46  \\
Our competitor's test                &  72.321   &  141.384 \\
\bottomrule
\end{tabular}
}
\end{table}

%%%%%%%%%%%%%%%% end table  %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 


%%%%%%%%%%%%%%%%%  begin wide figure  %%%%%%%%%%%%%%%%%%%%%%%%%%%

\begin{figure*}[t]
\begin{minipage}[c]{0.5\textwidth}
\centering{
  \includegraphics{sample-figure-2a.pdf}
\subcaption{Interior region\label{fig:interior-region}}
}\end{minipage}
%%%%%%%%%%%%%
\begin{minipage}[c]{0.5\textwidth}
\centering{
\includegraphics{sample-figure-2b.pdf}
\subcaption{Exterior region\label{fig:exterior-region}}
}\end{minipage}
\caption{A figure with two subfigures  \cite{Lienhard2019b}}
\end{figure*}

%%%%%%%%%%%%%%%%%%%  end wide figure  %%%%%%%%%%%%%%%%%%%%%%%%%%%%%



\section*{Entropy generation\footnote{If you have text in a section heading or caption that you do not want to be capitalized, enclose it in a \texttt{\textbackslash NoCaseChange} command.} is always interesting and important \cite{bejan}}

\lipsum[7-8] %%% This command generates paragraphs of fake Latin.  Delete it here and elsewhere!



%% Subsections with math do not need special handling because they are neither uppercase nor bookmarked
%% Note that \dot or \vec go outside \mathsf{..}
\subsection*{Subsection with math: $\bm{\dot{\mathsf{S}}_{\textsf{gen}}}$ \cite{bejan}.}

\lipsum[10] 


\subsubsection*{Sub-subsection\footnote{Another longer footnote to show the leading and line breaking, and how it will sit at the bottom of a column. Another longer footnote to show the leading and line breaking, and how it will sit at the bottom of a column.}  heading}
\lipsum[12-13] 
\begin{equation}\label{eqn:dw}
d\vec{w} =
   \begin{pmatrix}
 	du \\ dv
   \end{pmatrix} = 
   \underbrace{\begin{pmatrix}
	 \partial u/\partial x &  \partial u/\partial y \\
	 \partial v/\partial x &  \partial v/\partial y
   \end{pmatrix}}_{=\,\mathbf{J}_1}  \begin{pmatrix}
 	dx \\ dy
   \end{pmatrix} 
\end{equation}

%%%%%%%%%%%%%%% begin table %%%%%%%%%%%%%%%%%% 
\begin{table*}[t]
\caption{A table spanning two columns}\label{tab:3}%
\centering{%
\begin{tabular*}{0.8\textwidth}{@{\hspace*{1.5em}}@{\extracolsep{\fill}}ccc!{\hspace*{3.em}}ccc@{\hspace*{1.5em}}}
\toprule
\multicolumn{1}{@{\hspace*{1.5em}}c}{$x$\rule{0pt}{11pt}} &
\multicolumn{1}{c}{$\textrm{erf}(x)$} &
\multicolumn{1}{c!{\hspace*{3.em}}}{$\textrm{erfc}(x)$} &
\multicolumn{1}{c}{$x$} &
\multicolumn{1}{c}{$\textrm{erf}(x)$} &
\multicolumn{1}{c@{\hspace*{1.5em}}}{$\textrm{erfc}(x)$} \\ \midrule
0.00 & 0.00000 & 1.00000 & 1.10 & 0.88021 & 0.11980\rule{0pt}{11pt} \\
0.05 & 0.05637 & 0.94363 & 1.20 & 0.91031 & 0.08969 \\
0.10 & 0.11246 & 0.88754 & 1.30 & 0.93401 & 0.06599 \\
0.15 & 0.16800 & 0.83200 & 1.40 & 0.95229 & 0.04771 \\
0.20 & 0.22270 & 0.77730 & 1.50 & 0.96611 & 0.03389 \\
0.30 & 0.32863 & 0.67137 & 1.60 & 0.97635 & 0.02365 \\
0.40 & 0.42839 & 0.57161 & 1.70 & 0.98379 & 0.01621 \\
0.50 & 0.52050 & 0.47950 & 1.80 & 0.98909 & 0.01091 \\
0.60 & 0.60386 & 0.39614 & 1.82\makebox[0pt][l]{14} & 0.99000 & 0.01000 \\
0.70 & 0.67780 & 0.32220 & 1.90 & 0.99279 & 0.00721 \\
0.80 & 0.74210 & 0.25790 & 2.00 & 0.99532 & 0.00468 \\
0.90 & 0.79691 & 0.20309 & 2.50 & 0.99959 & 0.00041 \\
1.00 & 0.84270 & 0.15730 & 3.00 & 0.99998 & 0.00002 \\[2pt]
\bottomrule\end{tabular*}
}
\end{table*}
%%%%%%%%%%%%%%%% end table %%%%%%%%%%%%%%%%%%% 

\lipsum[16]%%% This command generates paragraphs of fake Latin.  Delete it here and elsewhere!


\section*{Acknowledgements}
\lipsum[17]%%% This command generates paragraphs of fake Latin.  Delete it here and elsewhere!



%%%  NOMENCLATURE  %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%
%% To add more space between the symbols and their definitions, use \begin{nomenclature}[Xcm] where X is a number 
%% The unit cm can be replaced by any LaTeX unit of dimension: pt, in, ex, em, pc, etc.
%%

\begin{nomenclature}
\entry{\textit{Roman letters}}{}
\entry{$k$}{Thermal conductivity [W m$^{-1}$ K$^{-1}$]}
\entry{$\vec{q}$}{Heat flux vector [W m$^{-2}$]}

\entry{\textit{Greek letters}\rule{0pt}{13pt}}{}
\entry{$\alpha$}{Thermal diffusivity [m$^2$ s$^{-1}$]}
\entry{$\nu$}{Kinematic viscosity [m$^2$ s$^{-1}$]}

\entry{\textit{Dimensionless groups}\rule{0pt}{13pt}}{}
\entry{Pr}{Prandtl number, $\nu/\alpha$}

\entry{\textit{Superscripts and subscripts}\rule{0pt}{13pt}}{}
\entry{b}{bulk value}
\entry{$\infty$}{free stream value}

\end{nomenclature}


%%%  REFERENCES  %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%
%% Put your references into your .bib file in the usual way. Run latex once, bibtex once, then latex twice.
%% This specific .bst style allows: venue = {location of conference}, and confmonth = {Month days}
%%

\nocite{*} %% <=== delete this line unless you want to typeset the entire contents of your .bib file.
\bibliographystyle{asmeconf}     %% .bst file following ASME conference format
\bibliography{asmeconf-sample}   %% name of your bib file

%%%  APPENDICES  %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\appendix

\section{First appendix}
\lipsum[20]%%% This command generates paragraphs of fake Latin.  Delete it here and elsewhere!


%% Here we use the optional argument for the pdf bookmark.
\section[The vector product AxB]{The vector product $\bm{\vec{\mathsf A}\times\vec{\mathsf B}}$}

\lipsum[21]%%% This command generates paragraphs of fake Latin.  Delete it here and elsewhere!
\begin{align}
\frac{d\Gamma}{dt}   &{}= \int_{\mathcal{C}} \frac{D\mathbf{u}}{Dt} \cdot d\mathbf{r}\\
                                  &{}= \iint_{\mathcal{S}} \nabla \times \frac{D\mathbf{u}}{Dt}  \cdot d\mathbf{A}\\
                                  &{}= \iint_{\mathcal{S}}  \nabla p \times \nabla \left( \frac{1}{\rho}\right) \cdot d\mathbf{A}
\end{align}
\lipsum[22]%%% This command generates paragraphs of fake Latin.  Delete it here and elsewhere!

\subsection*{A subsection in an appendix}
\lipsum[23]%%% This command generates paragraphs of fake Latin.  Delete it here and elsewhere!

\end{document}