nextsimdg
MODEL DESCRIPTION
Model Overview
Model Components
Numerical Implementation
Outputs and diagnostics
Using XIOS for reading and writing files
Halo Exchange Logic
INSTALLATION
Installation
Changelog
USAGE
Getting Started
API Documentation
Library API
Page Hierarchy
Full API
Namespaces
Classes and Structs
Enums
Functions
Function ArraySlicer::operator<<(std::ostream&, const Slice::Bounds&)
Function ArraySlicer::operator<<(std::ostream&, const Slice::VBounds&)
Function ArraySlicer::operator<<(std::ostream&, const Slice&)
Function ArraySlicer::operator<<(std::ostream&, const SliceIter&)
Function CGField
Function cxios_axis_handle_create
Function cxios_axis_valid_id
Function cxios_context_close_definition
Function cxios_context_finalize
Function cxios_context_get_current
Function cxios_context_get_id
Function cxios_context_initialize
Function cxios_context_is_initialized
Function cxios_context_valid_id
Function cxios_date_convert_from_string
Function cxios_date_convert_to_string
Function cxios_domain_handle_create
Function cxios_domain_valid_id
Function cxios_domaingroup_handle_create
Function cxios_duration_convert_from_string
Function cxios_duration_convert_to_string
Function cxios_field_handle_create
Function cxios_field_valid_id
Function cxios_fieldgroup_handle_create
Function cxios_file_handle_create
Function cxios_file_valid_id
Function cxios_filegroup_handle_create
Function cxios_finalize
Function cxios_get_axis_n_glo
Function cxios_get_calendar_wrapper_date_start_date
Function cxios_get_current_calendar_wrapper
Function cxios_get_current_date
Function cxios_get_field_freq_offset
Function cxios_get_field_grid_ref
Function cxios_get_field_read_access
Function cxios_get_file_output_freq
Function cxios_grid_handle_create
Function cxios_grid_valid_id
Function cxios_gridgroup_handle_create
Function cxios_init_client
Function cxios_is_defined_axis_n_glo
Function cxios_is_defined_calendar_wrapper_start_date
Function cxios_is_defined_calendar_wrapper_timestep
Function cxios_is_defined_domain_dim_i_name
Function cxios_is_defined_domain_dim_j_name
Function cxios_is_defined_domain_ibegin
Function cxios_is_defined_domain_jbegin
Function cxios_is_defined_domain_lat_name
Function cxios_is_defined_domain_latvalue_1d
Function cxios_is_defined_domain_lon_name
Function cxios_is_defined_domain_lonvalue_1d
Function cxios_is_defined_domain_ni
Function cxios_is_defined_domain_ni_glo
Function cxios_is_defined_domain_nj
Function cxios_is_defined_domain_nj_glo
Function cxios_is_defined_domain_type
Function cxios_is_defined_field_freq_offset
Function cxios_is_defined_field_grid_ref
Function cxios_is_defined_field_name
Function cxios_is_defined_field_operation
Function cxios_is_defined_field_read_access
Function cxios_is_defined_file_mode
Function cxios_is_defined_file_name
Function cxios_is_defined_file_output_freq
Function cxios_is_defined_file_par_access
Function cxios_is_defined_file_split_freq
Function cxios_is_defined_file_split_freq_format
Function cxios_is_defined_file_type
Function cxios_read_data_k82
Function cxios_read_data_k83
Function cxios_set_calendar_wrapper_date_start_date
Function cxios_set_calendar_wrapper_timestep
Function cxios_set_domain_dim_i_name
Function cxios_set_domain_dim_j_name
Function cxios_set_domain_ibegin
Function cxios_set_domain_jbegin
Function cxios_set_domain_lat_name
Function cxios_set_domain_latvalue_1d
Function cxios_set_domain_lon_name
Function cxios_set_domain_lonvalue_1d
Function cxios_set_domain_ni
Function cxios_set_domain_ni_glo
Function cxios_set_domain_nj
Function cxios_set_domain_nj_glo
Function cxios_set_domain_type
Function cxios_set_field_field_ref
Function cxios_set_field_freq_offset
Function cxios_set_field_grid_ref
Function cxios_set_field_name
Function cxios_set_field_operation
Function cxios_set_field_read_access
Function cxios_set_file_mode
Function cxios_set_file_name
Function cxios_set_file_output_freq
Function cxios_set_file_par_access
Function cxios_set_file_split_freq
Function cxios_set_file_split_freq_format
Function cxios_set_file_type
Function cxios_update_calendar
Function cxios_update_calendar_timestep
Function cxios_write_data_k82
Function cxios_write_data_k83
Function cxios_xml_tree_add_domain
Function cxios_xml_tree_add_domaintogrid
Function cxios_xml_tree_add_field
Function cxios_xml_tree_add_fieldtofile
Function cxios_xml_tree_add_file
Function cxios_xml_tree_add_grid
Function DGField
Function DGSField
Template Function EnumWrap::operator>>
Function FourDField
Function HField()
Function HField()
Function if
Template Function Indexer::deIndexer
Template Function Indexer::indexer
Function main(int, char *)
Function main(int, char **)
Function main(int, char **)
Function makeZeroStep
Function match12
Function matchIndices
Template Function Module::finalize
Template Function Module::getHelpRecursive
Specialized Template Function Module::getHelpRecursive< Nextsim::IDynamics >
Template Function Module::getImplementation
Specialized Template Function Module::getImplementation< Nextsim::IDynamics >
Template Function Module::getInstance
Template Function Module::implementation
Template Function Module::newImpl
Template Function Module::setImplementation
Function module_maker::denamespace
Function module_maker::generator
Function netCDF::setVariableCollective
Function newLinearFreezing
Function newUnescoFreezing
Function Nextsim::addTimeLeadingZeros
Function Nextsim::affixCoordinates
Function Nextsim::ansiMode
Function Nextsim::celsius
Function Nextsim::checkStartStep
Function Nextsim::close(diagFile)
Function Nextsim::close()
Function Nextsim::concatenateFields
Function Nextsim::coordinates
Function Nextsim::copyMeanComponent
Function Nextsim::defaultVal
Function Nextsim::degrees
Template Function Nextsim::Details::readConvertNetCDFVar
Function Nextsim::dimensionSetter
Function Nextsim::dumpModelState(state, filename, true)
Function Nextsim::dumpModelState(state, filename)
Function Nextsim::durationFromISO(const std::string&, int)
Function Nextsim::durationFromISO(std::istream&, int)
Function Nextsim::extractCoordinates
Function Nextsim::for()
Function Nextsim::for(auto arr :arrays)
Function Nextsim::fractional
Function Nextsim::fractionalDG
Function Nextsim::getAtt
Function Nextsim::getTimTime
Function Nextsim::index2d
Template Function Nextsim::initializeTestData(T&, size_t, size_t, size_t, size_t, bool)
Function Nextsim::initializeTestData(HField&, DGField&, HField&, VertexField&, HField&, HField&)
Function Nextsim::initializeTestData(fractional, fractionalDG, mask, coordinates, x, y)
Function Nextsim::isDOYFormat
Function Nextsim::isYMDFormat
Function Nextsim::julianGregorianShiftDays
Function Nextsim::kelvin
Function Nextsim::longRandomFilename
Function Nextsim::makeKokkosDeviceBitset
Function Nextsim::mask
Function Nextsim::mbar
Function Nextsim::mkgmtime
Function Nextsim::MPI_TEST_CASE(“test halo exchange on 3 proc grid”, 3)
Function Nextsim::MPI_TEST_CASE(“DGField”, 3)
Function Nextsim::MPI_TEST_CASE(“DGVector”, 3)
Function Nextsim::MPI_TEST_CASE(“DGVectorHolder”, 3)
Function Nextsim::MPI_TEST_CASE(“CGVector”, 3)
Function Nextsim::MPI_TEST_CASE(“Test getPartitionMetadata closed boundary”, 3)
Function Nextsim::MPI_TEST_CASE(“Test getPartitionMetadata periodic boundary”, 3)
Function Nextsim::MPI_TEST_CASE(“TestXiosAxis”, 3)
Function Nextsim::MPI_TEST_CASE(“TestXiosCalendar”, 1)
Function Nextsim::MPI_TEST_CASE(“TestXiosReadDiagnostic”, 3)
Function Nextsim::MPI_TEST_CASE(“TestXiosReadForcing”, 2)
Function Nextsim::MPI_TEST_CASE(“TestXiosReadRestart”, 2)
Function Nextsim::MPI_TEST_CASE(“TestXiosReadWriteRestart”, 2)
Function Nextsim::MPI_TEST_CASE(“TestXiosWriteDiagnostic”, 2)
Function Nextsim::MPI_TEST_CASE(“TestXiosWriteRestart”, 2)
Function Nextsim::ncFile
Function Nextsim::ncSuffix
Function Nextsim::operator””_ft
Function Nextsim::operator*(const FloatType&, const ModelArray&)
Function Nextsim::operator*(double, const Duration&)
Function Nextsim::operator*(const Duration&, double)
Function Nextsim::operator+
Function Nextsim::operator-
Function Nextsim::operator/(const FloatType&, const ModelArray&)
Function Nextsim::operator/(double, const Duration&)
Function Nextsim::operator/(const Duration&, double)
Function Nextsim::operator<<(std::ostream&, const ConfigurationHelp&)
Function Nextsim::operator<<(std::ostream&, const MASIter&)
Function Nextsim::operator<<(std::ostream&, const TimePoint&)
Function Nextsim::operator<<(std::ostream&, const Duration&)
Function Nextsim::operator>>(std::istream&, TimePoint&)
Function Nextsim::operator>>(std::istream&, Duration&)
Function Nextsim::option
Function Nextsim::pascals
Function Nextsim::perimeterBuffer(Eigen::seqN(0, nx), Eigen::all)
Function Nextsim::perimeterBuffer(Eigen::seqN(nx, ny), Eigen::all)
Function Nextsim::perimeterBuffer(Eigen::seqN(nx+ny, nx), Eigen::all)
Function Nextsim::perimeterBuffer(Eigen::seqN(2 *nx+ny, ny), Eigen::all)
Function Nextsim::radians
Template Function Nextsim::readNetCDFVar
Function Nextsim::reinitialize
Function Nextsim::REQUIRE(eaSrc(Indexer::indexer({ sliceNx, sliceNy }, { 2, 3 }), 4))
Function Nextsim::REQUIRE(maInter.)
Function Nextsim::REQUIRE(maInter.)
Function Nextsim::REQUIRE(maInter.)
Function Nextsim::REQUIRE(maInter.)
Function Nextsim::REQUIRE(maInter.)
Function Nextsim::REQUIRE(maInter.)
Function Nextsim::REQUIRE(maInter.)
Function Nextsim::REQUIRE(maInter.)
Function Nextsim::REQUIRE(maInter.)
Function Nextsim::REQUIRE(eaSink(Indexer::indexer({ sliceNx, sliceNy }, { 0, 0 }), 0))
Function Nextsim::REQUIRE(eaSink(Indexer::indexer({ sliceNx, sliceNy }, { 0, 0 }), 5))
Function Nextsim::REQUIRE(eaSink(Indexer::indexer({ sliceNx, sliceNy }, { 3, 5 }), 2))
Function Nextsim::REQUIRE(maSrc.)
Function Nextsim::REQUIRE(coordinates.)
Function Nextsim::REQUIRE(coordinates.)
Function Nextsim::REQUIRE(std::filesystem::exists(std::filesystem::path(filename)))
Function Nextsim::REQUIRE(ModelArray::nComponents(ModelArray::Type::DG))
Function Nextsim::REQUIRE(ModelArray::nComponents(ModelArray::Type::VERTEX))
Function Nextsim::REQUIRE(ms.data.)
Function Nextsim::REQUIRE(hiceRef.)
Function Nextsim::REQUIRE(hiceRef.)
Function Nextsim::REQUIRE(hiceRef.)
Function Nextsim::REQUIRE(coordRef.)
Function Nextsim::REQUIRE(coordRef.)
Function Nextsim::REQUIRE(coordRef.)
Function Nextsim::REQUIRE(coordRef.)
Function Nextsim::REQUIRE(coordRef.)
Function Nextsim::REQUIRE(ms.data., 0)
Function Nextsim::REQUIRE(xRef(3, 8))
Function Nextsim::REQUIRE(ms.data., 0)
Function Nextsim::REQUIRE(yRef(3, 8))
Function Nextsim::REQUIRE(ms.data., 0)
Function Nextsim::REQUIRE(ms.data.)
Function Nextsim::REQUIRE(Module::getImplementation<IStructure>)
Function Nextsim::REQUIRE(fractional.)
Function Nextsim::REQUIRE(std::filesystem::exists(std::filesystem::path(diagFile)))
Function Nextsim::REQUIRE(structureType)
Function Nextsim::REQUIRE(hiceVar.)
Function Nextsim::REQUIRE(ncFile., 0)
Function Nextsim::REQUIRE(ncFile., 0)
Function Nextsim::REQUIRE(ncFile., 0)
Function Nextsim::REQUIRE(ncFile., 0)
Function Nextsim::REQUIRE(state.data., 0)
Function Nextsim::REQUIRE(index2d(3, 5))
Function Nextsim::REQUIRE(ModelArray::dimensions(ModelArray::Type::H))
Function Nextsim::REQUIRE(ModelArray::dimensions(ModelArray::Type::H))
Function Nextsim::REQUIRE(ms.data.)
Function Nextsim::REQUIRE(ticeIn(targetX, targetY))
Function Nextsim::REQUIRE(ms.data.)
Function Nextsim::REQUIRE(ms.data.)
Function Nextsim::REQUIRE(ms.data.)
Function Nextsim::REQUIRE_THROWS
Function Nextsim::REQUIRE_THROWS_AS((ModelArrayAccessor<MiniModelComponent::H_ICE0, RW>(store)), std::logic_error)
Function Nextsim::REQUIRE_THROWS_AS((ModelArrayAccessor<MiniModelComponent::H_ICE, RW>(store, RO)), std::logic_error)
Function Nextsim::resize(sliceNx *, DG)
Function Nextsim::resize(2 *nx+2 *, DG)
Function Nextsim::runMe
Function Nextsim::section
Function Nextsim::setData
Function Nextsim::setIO(pio)
Function Nextsim::setIO(readIO)
Function Nextsim::setIO(new )
Function Nextsim::setTime(TimePoint(“2000-01-01T00:00:00Z”))
Function Nextsim::setTime(TimePoint(date_string))
Function Nextsim::splitString
Function Nextsim::structureNameFromFile
Function Nextsim::TEST_CASE(“Parse config file names”)
Function Nextsim::TEST_CASE(“Test snapshot output”)
Function Nextsim::TEST_CASE(“Parse one config stream using the raw configurator”)
Function Nextsim::TEST_CASE(“Parse one config stream using the pointer configuration function”)
Function Nextsim::TEST_CASE(“Parse two config streams for one, reference helper function”)
Function Nextsim::TEST_CASE(“Parse config streams for two overlapping, try”)
Function Nextsim::TEST_CASE(“Configure a module”)
Function Nextsim::TEST_CASE(“Configure a module from a stream”)
Function Nextsim::TEST_CASE(“Test the FileHolder class”)
Function Nextsim::TEST_CASE(“Close a file”)
Function Nextsim::TEST_CASE(“Duplicate functions”)
Function Nextsim::TEST_CASE(“Unique functions”)
Function Nextsim::TEST_CASE(“Finalize”)
Function Nextsim::TEST_CASE(“Exception”)
Function Nextsim::TEST_CASE(“Count iterator testing”)
Function Nextsim::TEST_CASE(“Two dimensional data access test”)
Function Nextsim::TEST_CASE(“Higher dimensional indexing”)
Function Nextsim::TEST_CASE(“Higher dimensional indexing 2”)
Function Nextsim::TEST_CASE(“Copy constructor and copy assignment operator”)
Function Nextsim::TEST_CASE(“Instance setDimensions sets instance dimensions”)
Function Nextsim::TEST_CASE(“Arithmetic tests”)
Function Nextsim::TEST_CASE(“Location from index”)
Function Nextsim::TEST_CASE(“Components”)
Function Nextsim::TEST_CASE(“Direct DataType access”)
Function Nextsim::TEST_CASE(“Accessing the data”)
Function Nextsim::TEST_CASE(“Accessing the data two ways”)
Function Nextsim::TEST_CASE(“Full component access”)
Function Nextsim::TEST_CASE(“Assign scalar to slice”)
Function Nextsim::TEST_CASE(“Slice to Slice”)
Function Nextsim::TEST_CASE(“ModelArray to Slice”)
Function Nextsim::TEST_CASE(“Slice to ModelArray”)
Function Nextsim::TEST_CASE(“Index a ModelArray with a Slice”)
Function Nextsim::TEST_CASE(“Test buffers”)
Function Nextsim::TEST_CASE(“General slice creation”)
Function Nextsim::TEST_CASE(“Iterators”)
Function Nextsim::TEST_CASE(“Eigen copying”)
Function Nextsim::TEST_CASE(“Test array registration”)
Function Nextsim::TEST_CASE(“Shared and semi-protected arrays”)
Function Nextsim::TEST_CASE(“Test cyclicity”)
Function Nextsim::TEST_CASE(“Albedo values”)
Function Nextsim::TEST_CASE(“PrognosticData call order test”)
Function Nextsim::TEST_CASE(“TimePoint parsing and formating”)
Function Nextsim::TEST_CASE(“Julian-Gregorian shifts”)
Function Nextsim::TEST_CASE(“mkgmtime”)
Function Nextsim::TEST_CASE(“timeFromISO”)
Function Nextsim::TEST_CASE(“TimePoints”)
Function Nextsim::TEST_CASE(“Durations”)
Function Nextsim::TEST_CASE(“gmtime and doy”)
Function Nextsim::TEST_SUITE_BEGIN(“CommandLineParser”)
Function Nextsim::TEST_SUITE_BEGIN(“ConfigOutput”)
Function Nextsim::TEST_SUITE_BEGIN(“Configurator”)
Function Nextsim::TEST_SUITE_BEGIN(“ConfiguredModule”)
Function Nextsim::TEST_SUITE_BEGIN(“FileCallbackCloser”)
Function Nextsim::TEST_SUITE_BEGIN(“ModelFinalizer”)
Function Nextsim::TEST_SUITE_BEGIN(“Halo exchange tests”)
Function Nextsim::TEST_SUITE_BEGIN(“Iterator”)
Function Nextsim::TEST_SUITE_BEGIN(“ModelArray”)
Function Nextsim::TEST_SUITE_BEGIN(“”)
Function Nextsim::TEST_SUITE_BEGIN(“ModelArraySlice”)
Function Nextsim::TEST_SUITE_BEGIN(“ModelComponent”)
Function Nextsim::TEST_SUITE_BEGIN(“ModelMetadata”)
Function Nextsim::TEST_SUITE_BEGIN(“MonthlyCubicBSpline”)
Function Nextsim::TEST_SUITE_BEGIN(“ParaGrid”)
Function Nextsim::TEST_SUITE_BEGIN(“PrognosticData”)
Function Nextsim::TEST_SUITE_BEGIN(“PrognosticDataIO”)
Function Nextsim::TEST_SUITE_BEGIN(“RectGrid”)
Function Nextsim::TEST_SUITE_BEGIN(“Time”)
Function Nextsim::TEST_SUITE_END
Function Nextsim::testNonPeriodicBC(int)
Function Nextsim::testNonPeriodicBC(int)
Function Nextsim::throwHappy
Function Nextsim::timeFromISO(const std::string&)
Function Nextsim::timeFromISO(std::istream&)
Function Nextsim::tmDoy
Template Function Nextsim::tryConfigure(T&)
Template Function Nextsim::tryConfigure(T *)
Function Nextsim::type
Template Function Nextsim::verifyTestData
Function Nextsim::x
Function Nextsim::y
Template Function Nextsim::zeroTime
Specialized Template Function Nextsim::zeroTime< size_t >
Specialized Template Function Nextsim::zeroTime< std::chrono::time_point< Iterator::Clock > >
Function OneDField
Function TEST_CASE(“indexer <-> deIndexer”)
Function TEST_CASE(“One dimensional indexing”)
Function TEST_CASE(“Multidimensional indexing”)
Function TEST_CASE(“Negative steps”)
Function TEST_CASE(“Test matchIndices”)
Function TEST_CASE(“Indexing behaviour”)
Function TEST_CASE(“Zero step”)
Function TEST_CASE(“SliceIter equality”)
Function TEST_CASE(“Two, slicing the end of the second dimension”)
Function TEST_SUITE_BEGIN(“Indexer”)
Function TEST_SUITE_BEGIN(“Slice”)
Function TEST_SUITE_END
Function ThreeDField
Function to_string(const MultiDim&)
Function to_string(const Slice&)
Function TwoDField
Function UField()
Function UField()
Function VertexField()
Function VertexField()
Function VField()
Function VField()
Function ZUField
Variables
Defines
Typedefs
Index
nextsimdg
Library API
Function Nextsim::fractional
View page source
Function Nextsim::fractional
¶
Function Documentation
¶
HField
Nextsim
::
fractional
(
ModelArray
::
Type
::
H
)
¶