Issue 108

[lsawade]

Description

This Pull request is addressing #108 and sub issues:

• Move the constructor for mesh struct mesh(const std::string filename, const specfem::MPI::MPI *mpi); to a function IO namespace since this constructors reads an external database file. The IO function should return specfem::mesh::mesh instance. #146
• Move function specfem::sources::read_sources(args...) #150
• Move function specfem::receivers::read_receivers(args...) to IO namespace #169

Checklist

Please make sure to check developer documentation on specfem docs.

• I ran the code through pre-commit to check style
• My code passes all the integration tests
• I have added sufficient unittests to test my changes
• I have added/updated documentation for the changes I am proposing
• I have updated CMakeLists to ensure my code builds
• My code builds across all platforms

[buildbot-princeton]

Can one of the admins verify this patch?

[buildbot-princeton]

Can one of the admins verify this patch?

[buildbot-princeton]

Can one of the admins verify this patch?

[Rohit-Kakodkar]

You dont nacessarily need this explicit instantiation here, since, this function is only ever used by read_coupled_interfaces. read_coupled_interfaces knows the definition from above function and wouldn't use the explicit instantiation I believe.

[Rohit-Kakodkar]

Do we want to have both includes within the same header? What would be the best name?

[lsawade]

I was thinking about this while I was creating the read_sources. I think:

IO should contain read_mesh, read_sources, and read_receivers.

[Rohit-Kakodkar]

Do you mean we should move other IO routines fortran, HDF5 and ASCII to another namespace?

[lsawade]

Will create IO/interface.hpp for the implementations of the read_<xxx> functions, such that read_sources, read_mesh, and read_receivers are in the IO namespace under the interface header.

[Rohit-Kakodkar]

Do you mean we should move other IO routines fortran, HDF5 and ASCII to another namespace?

[Rohit-Kakodkar]

retest this please

[lsawade]

@Rohit-Kakodkar there was a rogue mesh/mpi_interfaces/mpi_interfaces.cpp module that was being linked against, but it is currently unused. I kept it in the repo, but commented it out in the CmakeLists.txt, for now.

If I understood the snippet correctly it should replace this:

SPECFEMPP/src/IO/mesh/read_mesh.cpp

Line 112 in b33013a

specfem::IO::fortran_read_line(stream, &ninterfaces, &max_interface_size);

If that's the case, I could add it to the read_mesh constructor, create the interfaces and add it to the mesh object.

[Rohit-Kakodkar]

@Rohit-Kakodkar there was a rogue mesh/mpi_interfaces/mpi_interfaces.cpp module that was being linked against, but it is currently unused. I kept it in the repo, but commented it out in the CmakeLists.txt, for now.

If I understood the snippet correctly it should replace this:

SPECFEMPP/src/IO/mesh/read_mesh.cpp

Line 112 in b33013a

specfem::IO::fortran_read_line(stream, &ninterfaces, &max_interface_size);

If that's the case, I could add it to the read_mesh constructor, create the interfaces and add it to the mesh object.

Yes that should work. Currently, we dont use the mpi_interfaces but we will need it in the future

[lsawade]

retest this please

[Rohit-Kakodkar]

retest this please