59 lines
1.4 KiB
Groff
59 lines
1.4 KiB
Groff
|
.TH "src/include/serif/model/eos_reference.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
||
|
|
.ad l
|
||
|
|
.nh
|
||
|
|
.SH NAME
|
||
|
|
src/include/serif/model/eos_reference.hpp
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.br
|
||
|
|
.PP
|
||
|
|
\fR#include <memory>\fP
|
||
|
|
.br
|
||
|
|
\fR#include <stdexcept>\fP
|
||
|
|
.br
|
||
|
|
\fR#include <type_traits>\fP
|
||
|
|
.br
|
||
|
|
\fR#include <utility>\fP
|
||
|
|
.br
|
||
|
|
\fR#include 'serif/utils/error/errors\&.hpp'\fP
|
||
|
|
.br
|
||
|
|
|
||
|
|
.SS "Classes"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "class \fBserif::model::EosReference< EOS >\fP"
|
||
|
|
.br
|
||
|
|
.RI "Reuse one immutable EOS in equation objects, optionally retaining shared ownership\&. "
|
||
|
|
.in -1c
|
||
|
|
.SS "Namespaces"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "namespace \fBserif\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "namespace \fBserif::model\fP"
|
||
|
|
.br
|
||
|
|
.in -1c
|
||
|
|
.SS "Functions"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "template<typename Model> auto \fBserif::model::share_equation_of_state\fP (std::shared_ptr< const Model > model)"
|
||
|
|
.br
|
||
|
|
.RI "Share the EOS subobject while retaining the model that owns it\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "template<typename EOS> \fBEosReference\fP< EOS > \fBserif::model::borrow_eos\fP (const EOS &eos) noexcept"
|
||
|
|
.br
|
||
|
|
.RI "Borrow the model-owned EOS when the prepared graph already retains its immutable model owner\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "template<typename EOS>
|
||
|
|
.br
|
||
|
|
requires (!std::is_lvalue_reference_v<EOS>)void \fBserif::model::borrow_eos\fP (EOS &&)=delete"
|
||
|
|
.br
|
||
|
|
.RI "Borrowing never extends a temporary EOS lifetime\&. "
|
||
|
|
.in -1c
|
||
|
|
.SH "Author"
|
||
|
|
.PP
|
||
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|