GitHub - ianabel/dispreln: Linear Dispersion Relation solver for various slab plasma models

ianabel / dispreln Public

Notifications You must be signed in to change notification settings
Fork 0
Star 1

Linear Dispersion Relation solver for various slab plasma models

Notifications

Name		Name	Last commit message	Last commit date
Latest commit History 34 Commits
.circleci		.circleci
Reference Cases		Reference Cases
SlabETG		SlabETG
docs		docs
examples		examples
test-data		test-data
working		working
.gitignore		.gitignore
COPYING		COPYING
Config.cpp		Config.cpp
Config.h		Config.h
DispHarness.cpp		DispHarness.cpp
DispReln.cpp		DispReln.cpp
DispReln.h		DispReln.h
DispRelnTests.cpp		DispRelnTests.cpp
DispSolver.cpp		DispSolver.cpp
ExpBessel.h		ExpBessel.h
Faddeeva.cc		Faddeeva.cc
Faddeeva.hh		Faddeeva.hh
Makefile		Makefile
ParameterScan.h		ParameterScan.h
README		README
RootFinder.cpp		RootFinder.cpp
RootFinder.h		RootFinder.h
RootFindingTests.cpp		RootFindingTests.cpp
RootTracking.h		RootTracking.h
Solver.cpp		Solver.cpp
TODO		TODO
ky-drift-badger		ky-drift-badger

Repository files navigation

==================================================================================
README for Dispersion Relation Solver Package
Copyright 2018 Ian Abel
==================================================================================

A framework for solving the kinds of dispersion relations that arise from slab
gyrokinetics and its close relatives.

=================================================================================
WARNINGS
=================================================================================

1. These implementations have been only tested to moderate tolerances.
   It may not be possible to achieve machine precision with the current
   implementations.

2. The efficiency of these algorithms was *sufficient for the job at hand* when 
   they were first written. It is by no means the optimal implementation.

3. The build system, such as it is,  is a makefile. It is less portable than your
   average ten ton rock. It works on modern linux distributions, including 
   debian (buster or newer) and ubuntu. 

=================================================================================
What Now?
=================================================================================

If you have a functional C++ build environment, 'make' should produce the main
executable file 'DispSolver'. This is driven by an XML configuration file.

Example configurations files will be in the examples/ directory. 

Full documentation is in the docs/ subdirectory.

The licence and copying restrictions for this software is contained in the 
COPYING file.