seams-core v2.14.0
libyodaLib, the C++ engine of d-SEAMS
Loading...
Searching...
No Matches
seams::Brine Class Reference

Owned planar ice-front measurement. More...

#include <include/seams.hpp>

Inheritance diagram for seams::Brine:

Public Member Functions

BrineFronts fronts () const
 The two planar crossings.
Rejection rejection () const
 Molal rejection coefficient.
BrineProfile profile () const
 Concentration profile along the front axis.
Pockets pockets () const
 Pockets trapped in the ice, and the liquid reservoir.
Public Member Functions inherited from seams::detail::Handle< seams_brine, seams_brine_destroy >
 Handle ()=default
Handle & operator= (const Handle &)=delete
 ~Handle ()
 operator bool () const noexcept

Additional Inherited Members

Protected Member Functions inherited from seams::detail::Handle< seams_brine, seams_brine_destroy >
seams_brine * get () const noexcept
void reset () noexcept
Protected Attributes inherited from seams::detail::Handle< seams_brine, seams_brine_destroy >
seams_brine * ptr_

Detailed Description

Owned planar ice-front measurement.

Definition at line 882 of file seams.hpp.

Member Function Documentation

◆ fronts()

BrineFronts seams::Brine::fronts ( ) const
inlinenodiscard

The two planar crossings.

Lengths are Angstrom.

Definition at line 887 of file seams.hpp.

887 {
888 BrineFronts out;
889 int found = 0;
890 detail::check(seams_brine_fronts(get(), &out.enter, &out.exit, &out.thickness, &found), get());
891 out.found = found != 0;
892 return out;
893 }
SEAMS_API seams_status seams_brine_fronts(const seams_brine *front, double *z_enter, double *z_exit, double *thickness, int *found)
The two planar crossings of the ice slab.
void check(int status, const void *handle)
Definition seams.hpp:557

◆ pockets()

Pockets seams::Brine::pockets ( ) const
inlinenodiscard

Pockets trapped in the ice, and the liquid reservoir.

Definition at line 922 of file seams.hpp.

922 {
923 Pockets out;
924 detail::check(seams_brine_pockets(get(), &out.pockets, &out.reservoir_waters), get());
925 return out;
926 }
SEAMS_API seams_status seams_brine_pockets(const seams_brine *front, int *n_pockets, int *reservoir_waters)
Brine pockets trapped in the ice, excluding the liquid reservoir.

◆ profile()

BrineProfile seams::Brine::profile ( ) const
inlinenodiscard

Concentration profile along the front axis.

Definition at line 905 of file seams.hpp.

905 {
906 std::size_t n_out = 0;
907 detail::check(seams_brine_profile(get(), nullptr, nullptr, nullptr, 0, &n_out), get());
908 BrineProfile out;
909 out.coordinate.resize(n_out);
910 out.molality.resize(n_out);
911 out.ice_fraction.resize(n_out);
912 detail::check(seams_brine_profile(get(), out.coordinate.data(), out.molality.data(),
913 out.ice_fraction.data(), n_out, &n_out),
914 get());
915 out.coordinate.resize(n_out);
916 out.molality.resize(n_out);
917 out.ice_fraction.resize(n_out);
918 return out;
919 }
SEAMS_API seams_status seams_brine_profile(const seams_brine *front, double *z_mid, double *molality, double *ice_fraction, size_t cap, size_t *n_out)
Concentration profile along the front axis.

◆ rejection()

Rejection seams::Brine::rejection ( ) const
inlinenodiscard

Molal rejection coefficient.

Molality is mol/kg.

Definition at line 896 of file seams.hpp.

896 {
897 Rejection out;
898 int defined = 0;
899 detail::check(seams_brine_rejection(get(), &out.ice, &out.liquid, &out.k, &defined), get());
900 out.defined = defined != 0;
901 return out;
902 }
SEAMS_API seams_status seams_brine_rejection(const seams_brine *front, double *c_ice, double *c_liquid, double *k, int *defined)
Molal rejection coefficient k = c_ice / c_liquid.

The documentation for this class was generated from the following file: