Homec4science
Diffusion µSpectre (feat/named_parameter_pack_T2536) Browse

muSpectre/src/fft/projection_default.hh
d1dd9e291af5feat/named_parameter_pa…

Last Change
Raw File

projection_default.hh
View Options

/**
* @file projection_default.hh
*
* @author Till Junge <till.junge@altermail.ch>
*
* @date 14 Jan 2018
*
* @brief virtual base class for default projection implementation, where the
* projection operator is stored as a full fourth-order tensor per
* k-space point (as opposed to 'smart' faster implementations, such as
* ProjectionFiniteStrainFast
*
* Copyright (C) 2018 Till Junge
*
* µSpectre is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation, either version 3, or (at
* your option) any later version.
*
* µSpectre 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 Lesser General Public License
* along with µSpectre; see the file COPYING. If not, write to the
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* * Boston, MA 02111-1307, USA.
*
* Additional permission under GNU GPL version 3 section 7
*
* If you modify this Program, or any covered work, by linking or combining it
* with proprietary FFT implementations or numerical libraries, containing parts
* covered by the terms of those libraries' licenses, the licensors of this
* Program grant you additional permission to convey the resulting work.
*/
#ifndef SRC_FFT_PROJECTION_DEFAULT_HH_
#define SRC_FFT_PROJECTION_DEFAULT_HH_
#include "fft/projection_base.hh"
namespace muSpectre {
/**
* base class to inherit from if one implements a projection
* operator that is stored in form of a fourth-order tensor of real
* values per k-grid point
*/
template <Dim_t DimS, Dim_t DimM>
class ProjectionDefault : public ProjectionBase<DimS, DimM> {
public:
using Parent = ProjectionBase<DimS, DimM>; //!< base class
using Vector_t = typename Parent::Vector_t; //!< to represent fields
//! polymorphic FFT pointer type
using FFTEngine_ptr = typename Parent::FFTEngine_ptr;
using Ccoord = typename Parent::Ccoord; //!< cell coordinates type
using Rcoord = typename Parent::Rcoord; //!< spatial coordinates type
//! global field collection
using GFieldCollection_t = GlobalFieldCollection<DimS>;
//! local field collection for Fourier-space fields
using LFieldCollection_t = LocalFieldCollection<DimS>;
//! Real space second order tensor fields (to be projected)
using Field_t = TypedField<GFieldCollection_t, Real>;
//! Fourier-space field containing the projection operator itself
using Proj_t = TensorField<LFieldCollection_t, Real, fourthOrder, DimM>;
//! iterable form of the operator
using Proj_map = T4MatrixFieldMap<LFieldCollection_t, Real, DimM>;
//! vectorized version of the Fourier-space second-order tensor field
using Vector_map =
MatrixFieldMap<LFieldCollection_t, Complex, DimM * DimM, 1>;
//! Default constructor
ProjectionDefault() = delete;
//! Constructor with cell sizes and formulation
ProjectionDefault(FFTEngine_ptr engine, Rcoord lengths, Formulation form);
//! Copy constructor
ProjectionDefault(const ProjectionDefault & other) = delete;
//! Move constructor
ProjectionDefault(ProjectionDefault && other) = default;
//! Destructor
virtual ~ProjectionDefault() = default;
//! Copy assignment operator
ProjectionDefault & operator=(const ProjectionDefault & other) = delete;
//! Move assignment operator
ProjectionDefault & operator=(ProjectionDefault && other) = delete;
//! apply the projection operator to a field
void apply_projection(Field_t & field) final;
Eigen::Map<Eigen::ArrayXXd> get_operator() final;
/**
* returns the number of rows and cols for the strain matrix type
* (for full storage, the strain is stored in material_dim ×
* material_dim matrices, but in symmetriy storage, it is a column
* vector)
*/
std::array<Dim_t, 2> get_strain_shape() const final;
constexpr static Dim_t NbComponents() { return ipow(DimM, 2); }
protected:
Proj_t & Gfield; //!< field holding the operator
Proj_map Ghat; //!< iterable version of operator
};
} // namespace muSpectre
#endif // SRC_FFT_PROJECTION_DEFAULT_HH_
c4science · Help