Skip to content

itsAlexNoir/montecorvo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Montecorvo

Scientific code for solving fiber modal / spectral scanning problems.

Quick overview

  • Language: C++ (with Armadillo, MPI, SLEPc/PETSc integration)
  • License: MIT (see LICENSE)

Quick build

  1. Install dependencies: MPI implementation (OpenMPI/MPICH), PETSc/SLEPc, and Armadillo.
  2. From the repo root run make (the src/Makefile includes architecture-specific files in sys/).

Example run

  • See simulations/runtest for a small example input and prebuilt binary.

Repository layout

  • src/ : sources and Makefile used to build the executable (spectral_scan.exec).
    • Note: src/classes.lst contains the OBJS list used by the Makefile. Add new object files there when adding sources.
  • include/ : public headers describing major classes (fiber, communicator, params, etc.).
  • simulations/ : example cases and input files.
  • docs/ : additional documentation (this folder).

Where to look next

  • docs/usage.md — how to run simulations and example commands.
  • docs/development.md — build flags, adding new modules, and coding conventions.
  • docs/api.md — short reference for public headers in include/.

About

A FD grid-based code for obtaining electric field distributions in optical fibers.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors