94 lines
3.7 KiB
C
94 lines
3.7 KiB
C
|
/*
|
||
|
* Copyright (C) 2010 Thorsten Liebig (Thorsten.Liebig@gmx.de)
|
||
|
*
|
||
|
* This program is free software: you can redistribute it and/or modify
|
||
|
* it under the terms of the GNU General Public License as published by
|
||
|
* the Free Software Foundation, either version 3 of the License, or
|
||
|
* (at your option) any later version.
|
||
|
*
|
||
|
* This program is distributed in the hope that it will be useful,
|
||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
|
* GNU General Public License for more details.
|
||
|
*
|
||
|
* You should have received a copy of the GNU General Public License
|
||
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||
|
*/
|
||
|
|
||
|
#ifndef OPERATOR_BASE_H
|
||
|
#define OPERATOR_BASE_H
|
||
|
|
||
|
#include "tools/global.h"
|
||
|
#include "FDTD/processing.h"
|
||
|
#include "string"
|
||
|
|
||
|
class Operator_Base
|
||
|
{
|
||
|
public:
|
||
|
//! Get the timestep used by this operator
|
||
|
double GetTimestep() const {return dT;};
|
||
|
|
||
|
//! Get the number of cells or nodes defined by this operator
|
||
|
virtual double GetNumberCells() const {return 0;}
|
||
|
|
||
|
//! Get the number of timesteps satisfying the nyquist condition (may depend on the excitation)
|
||
|
unsigned int GetNumberOfNyquistTimesteps() const {return 0;}
|
||
|
|
||
|
//! Returns the number of lines as needed for post-processing etc. (for the engine, use GetOriginalNumLines())
|
||
|
virtual unsigned int GetNumberOfLines(int ny) const {return numLines[ny];}
|
||
|
|
||
|
//! Get the name for the given direction: 0 -> x, 1 -> y, 2 -> z
|
||
|
virtual std::string GetDirName(int ny) const;
|
||
|
|
||
|
//! Get the grid drawing unit in m
|
||
|
virtual double GetGridDelta() const {return 0;}
|
||
|
|
||
|
//! Get the mesh delta times the grid delta for a 3D position (unit is meter)
|
||
|
virtual double GetMeshDelta(int n, const unsigned int* pos, bool dualMesh=false) const {UNUSED(n);UNUSED(pos);UNUSED(dualMesh);return 0.0;}
|
||
|
|
||
|
//! Get the disc line in \a n direction (in drawing units)
|
||
|
virtual double GetDiscLine(int n, unsigned int pos, bool dualMesh=false) const {UNUSED(n);UNUSED(pos);UNUSED(dualMesh);return 0.0;}
|
||
|
|
||
|
//! Get the node width for a given direction \a n and a given mesh position \a pos
|
||
|
virtual double GetNodeWidth(int ny, const unsigned int pos[3], bool dualMesh = false) const {UNUSED(ny);UNUSED(pos);UNUSED(dualMesh);return 0.0;}
|
||
|
|
||
|
//! Get the node area for a given direction \a n and a given mesh position \a pos
|
||
|
virtual double GetNodeArea(int ny, const unsigned int pos[3], bool dualMesh = false) const {UNUSED(ny);UNUSED(pos);UNUSED(dualMesh);return 0.0;}
|
||
|
|
||
|
//! Get the length of an FDTD edge (unit is meter).
|
||
|
virtual double GetEdgeLength(int ny, const unsigned int pos[3], bool dualMesh = false) const {UNUSED(ny);UNUSED(pos);UNUSED(dualMesh);return 0.0;}
|
||
|
|
||
|
//! Get the area around an edge for a given direction \a n and a given mesh posisition \a pos
|
||
|
/*!
|
||
|
This will return the area around an edge with a given direction, measured at the middle of the edge.
|
||
|
In a cartesian mesh this is equal to the NodeArea, may be different in other coordinate systems.
|
||
|
*/
|
||
|
virtual double GetEdgeArea(int ny, const unsigned int pos[3], bool dualMesh = false) const {UNUSED(ny);UNUSED(pos);UNUSED(dualMesh);return 0.0;}
|
||
|
|
||
|
//! Snap the given coodinates to mesh indices
|
||
|
virtual bool SnapToMesh(double* coord, unsigned int* uicoord, bool lower=false, bool* inside=NULL) {UNUSED(coord);UNUSED(uicoord);UNUSED(lower);UNUSED(inside);return false;};
|
||
|
|
||
|
//! Set the boundary conditions
|
||
|
virtual void SetBoundaryCondition(int* BCs) {for (int n=0;n<6;++n) m_BC[n]=BCs[n];}
|
||
|
|
||
|
protected:
|
||
|
Operator_Base();
|
||
|
virtual ~Operator_Base();
|
||
|
|
||
|
virtual void Init();
|
||
|
virtual void Reset();
|
||
|
|
||
|
//! boundary conditions
|
||
|
int m_BC[6];
|
||
|
|
||
|
//! The operator timestep
|
||
|
double dT;
|
||
|
|
||
|
Processing::MeshType m_MeshType;
|
||
|
unsigned int numLines[3];
|
||
|
double* discLines[3];
|
||
|
double gridDelta;
|
||
|
};
|
||
|
|
||
|
#endif // OPERATOR_BASE_H
|