Navigation
Main Page
Download
Support
Installation
Tutorial
Examples
Reference Manual
Version 1.0.6dev
Class Index
File List
Version 1.0.6
Version 1.0.5new_solver
Version 1.0.5dev
Version 1.0.5b
Version 1.0.4dev
Version 1.0.4
Publications
Hosted by
EpotField Class Reference
Electric potential field. More...
#include <epot_field.hpp>
Inheritance diagram for EpotField:
Public Member Functions | |
| EpotField (const Geometry &geom) | |
| Constructor. More... | |
| EpotField (const EpotField &f) | |
| Copy constructor. More... | |
| EpotField (std::istream &s, const Geometry &geom) | |
| Constructor for loading EpotField field data from a file and using solid definitions from geom. More... | |
| virtual | ~EpotField () |
| Destructor. More... | |
| const Geometry * | geom (void) const |
| Get a pointer to geometry. More... | |
| virtual double | operator() (const Vec3D &x) const |
| Operator for getting linearly interpolated field values. More... | |
 Public Member Functions inherited from MeshScalarField | |
| MeshScalarField () | |
| Default constructor. More... | |
| MeshScalarField (const Mesh &m) | |
| Constructor for scalarfield from mesh. More... | |
| MeshScalarField (geom_mode_e geom_mode, Int3D size, Vec3D origo, double h) | |
| Constructor for set geometry. More... | |
| MeshScalarField (std::istream &s) | |
| Constructor for loading scalar field from a file. More... | |
| MeshScalarField (const MeshScalarField &f) | |
| Copy constructor. More... | |
| virtual | ~MeshScalarField () |
| Destructor. More... | |
| void | clear () |
| Clears the field. More... | |
| void | reset (geom_mode_e geom_mode, Int3D size, Vec3D origo, double h) |
| Resets the field geometry. More... | |
| void | get_minmax (double &min, double &max) const |
| Search minimum and maximum values of scalar field. More... | |
| MeshScalarField & | operator= (const MeshScalarField &f) |
| Copy operator. More... | |
| MeshScalarField & | operator+= (const MeshScalarField &f) |
| Accumulation operator. More... | |
| MeshScalarField & | operator-= (const MeshScalarField &f) |
| Inverse accumulation operator. More... | |
| MeshScalarField & | operator*= (double x) |
| Scaling operator. More... | |
| MeshScalarField & | operator/= (double x) |
| Inverse scaling operator. More... | |
| double & | operator() (int32_t i) |
| Operator for pointing to elements of the field mesh. More... | |
| double & | operator() (int32_t i, int32_t j) |
| Operator for pointing to elements of the field mesh. More... | |
| double & | operator() (int32_t i, int32_t j, int32_t k) |
| Operator for pointing to elements of the field mesh. More... | |
| const double & | operator() (int32_t i) const |
| Operator for pointing to elements of the field mesh. More... | |
| const double & | operator() (int32_t i, int32_t j) const |
| Operator for pointing to elements of the field mesh. More... | |
| const double & | operator() (int32_t i, int32_t j, int32_t k) const |
| Operator for pointing to elements of the field mesh. More... | |
| void | save (const std::string &filename) const |
| Saves scalar field data to file filename. More... | |
| void | save (std::ostream &os) const |
| Saves scalar field data to stream os. More... | |
| void | debug_print (std::ostream &os) const |
| Print debugging information to os. More... | |
| Public Member Functions inherited from ScalarField | |
| virtual | ~ScalarField () |
| Virtual destructor. More... | |
| Public Member Functions inherited from Field | |
| virtual | ~Field () |
| Virtual destructor. More... | |
| Public Member Functions inherited from Mesh | |
| Mesh () | |
| Default constructor for mesh definition. More... | |
| Mesh (geom_mode_e geom_mode, Int3D size, Vec3D origo, double h) | |
| Constructor for mesh definition. More... | |
| Mesh (std::istream &is) | |
| Constructoer for loading mesh from a stream is. More... | |
| ~Mesh () | |
| Destructor. More... | |
| void | reset (geom_mode_e geom_mode, Int3D size, Vec3D origo, double h) |
| Reset mesh definition. More... | |
| geom_mode_e | geom_mode (void) const |
| Returns geometry mode. More... | |
| uint32_t | dim (void) const |
| Returns number of dimensions in geometry. More... | |
| Int3D | size (void) const |
| Returns size array of geometry. More... | |
| uint32_t | size (int i) const |
| Returns size of solid mesh in direction i. More... | |
| uint32_t | nodecount (void) const |
| Returns number of nodes in the mesh. More... | |
| Vec3D | origo (void) const |
| Returns origo vector of geometry. More... | |
| double | origo (int i) const |
| Returns i-th component of vector origo. More... | |
| Vec3D | max (void) const |
| Returns vector pointing to the last mesh point opposite of origo. More... | |
| double | max (int i) const |
| Returns i-th component of vector pointing to the last mesh point opposite of origo. More... | |
| double | h (void) const |
| Returns mesh cell size. More... | |
| double | div_h (void) const |
| Returns reciprocal of mesh cell size (1/h). More... | |
| Int3D | closest_node (Vec3D x) const |
| Returns node closest to location x. More... | |
| Int3D | mesh_number (Vec3D x) const |
| Returns node, which contains x. More... | |
| Vec3D | coord_of_node (Int3D n) const |
| Returns coordinates of node i. More... | |
| void | save (std::ostream &os) const |
| Saves geometry data to stream os. More... | |
| bool | operator== (const Mesh &m) const |
| Equality. More... | |
| bool | operator!= (const Mesh &m) const |
| Non-equality. More... | |
| void | debug_print (std::ostream &os) const |
| Print debugging information to stream os. More... | |
Additional Inherited Members | |
| Protected Attributes inherited from MeshScalarField | |
| double * | _F |
| Scalar field data. More... | |
| Protected Attributes inherited from Mesh | |
| geom_mode_e | _geom_mode |
| Geometry mode More... | |
| Int3D | _size |
| Size of mesh. More... | |
| Vec3D | _origo |
| Location of mesh point (0,0,0) [m]. More... | |
| Vec3D | _max |
| Location of mesh point (size[0]-1,size[1]-1,size[2]-1) [m]. More... | |
| double | _h |
| Length of mesh step [m]. More... | |
| double | _div_h |
| Reciprocal of length of mesh step [1/m]. More... | |
Detailed Description
Electric potential field.
Electric potential field based on MeshScalarField. Contains an evaluator
Constructor & Destructor Documentation
◆ EpotField() [1/3]
| EpotField::EpotField | ( | const Geometry & | geom | ) |
Constructor.
The field is created using the mesh geometry and solid definitions of geom.
◆ EpotField() [2/3]
| EpotField::EpotField | ( | const EpotField & | f | ) |
Copy constructor.
◆ EpotField() [3/3]
| EpotField::EpotField | ( | std::istream & | s, |
| const Geometry & | geom | ||
| ) |
Constructor for loading EpotField field data from a file and using solid definitions from geom.
◆ ~EpotField()
|
virtual |
Destructor.
Member Function Documentation
◆ geom()
| const Geometry * EpotField::geom | ( | void | ) | const |
Get a pointer to geometry.
◆ operator()()
|
virtual |
Operator for getting linearly interpolated field values.
The field is interpolated linearly to get the field value at x. If x is outside the mesh, the field is extrapolated linearly using the field points to x. This provides correct field values also close to the mesh boundaries.
The near solid points are evaluated taking in account the distance to the solid surface.
Reimplemented from MeshScalarField.
The documentation for this class was generated from the following files:
- epot_field.hpp
- epot_field.cpp