volume

package
v1.0.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 27, 2020 License: MIT Imports: 13 Imported by: 0

Documentation

Overview

Package volume calculates the volume of a molecule in a solvent.

Index

Constants

This section is empty.

Variables

View Source
var Type = "volume"

Type is the type of calculation.

Functions

This section is empty.

Types

type Volume

type Volume struct {
	FileIn     string `toml:"volume.file_in"`
	FileOut    string `toml:"volume.file_out"`
	FileOutXYZ string `toml:"volume.file_out_xyz"`

	CfgStart   int `toml:"volume.cfg_start"`
	CfgEnd     int `toml:"volume.cfg_end"`
	CfgSpacing int `toml:"volume.cfg_spacing"`

	Bloc  []float64 `toml:"volume.bloc"`
	Blocs []int     `toml:"volume.blocs"` // Blocs around each atom

	Atoms []string           `toml:"volume.atoms"`
	Sigma map[string]float64 `toml:"volume.sigma"`

	Dt float64 `toml:"volume.dt"`
	// contains filtered or unexported fields
}

Volume is a structure containing the parameters that can be parsed from a TOML configuration file. This structure can be instanced through the New method. It also contains other unexported informations like the number of atoms, the number of columns, ... CfgStart must be lower than CfgEnd. Size of the Bloc and Blocs must be equal to 3.

func New

func New(path string) (*Volume, error)

New returns an instance of the Volume structure. It reads and parses the configuration file given in argument. The file must be a TOML file.

func (*Volume) Start

func (v *Volume) Start() error

Start performs the calculation. It is a thread blocking method. This calculation will use all the threads available.

type XYZ

type XYZ map[string][][3]float64

XYZ is a type that represents the coordinates for each atom.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL