Homec4science
Diffusion µSpectre (feat/documentation) Browse

muSpectre/src/fft/projection_finite_strain.hh
2ecbb615921afeat/documentation

Last Change
Raw File

projection_finite_strain.hh
View Options

/**
* @file projection_finite_strain.hh
*
* @author Till Junge <till.junge@altermail.ch>
*
* @date 05 Dec 2017
*
* @brief Class for standard finite-strain gradient projections see de Geus et
* al. (https://doi.org/10.1016/j.cma.2016.12.032) for derivation
*
* Copyright © 2017 Till Junge
*
* µSpectre 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, 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 General Public License
* along with GNU Emacs; see the file COPYING. If not, write to the
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
#ifndef PROJECTION_FINITE_STRAIN_H
#define PROJECTION_FINITE_STRAIN_H
#include "fft/projection_default.hh"
#include "common/common.hh"
#include "common/field_collection.hh"
#include "common/field_map.hh"
namespace muSpectre {
/**
* Implements the finite strain gradient projection operator as
* defined in de Geus et
* al. (https://doi.org/10.1016/j.cma.2016.12.032) for derivation
*/
template <Dim_t DimS, Dim_t DimM>
class ProjectionFiniteStrain: public ProjectionDefault<DimS, DimM>
{
public:
using Parent = ProjectionDefault<DimS, DimM>; //!< base class
//! polymorphic pointer to FFT engines
using FFT_Engine_ptr = typename Parent::FFT_Engine_ptr;
using Ccoord = typename Parent::Ccoord; //!< cell coordinates type
//! local field collection (for Fourier-space representations)
using LFieldCollection_t = LocalFieldCollection<DimS, DimM>;
//! iterable operator
using Proj_map = T4MatrixFieldMap<LFieldCollection_t, Real, DimM>;
//! iterable vectorised version of the Fourier-space tensor field
using Vector_map = MatrixFieldMap<LFieldCollection_t, Complex, DimM*DimM, 1>;
//! Default constructor
ProjectionFiniteStrain() = delete;
//! Constructor with fft_engine
ProjectionFiniteStrain(FFT_Engine_ptr engine);
//! Copy constructor
ProjectionFiniteStrain(const ProjectionFiniteStrain &other) = delete;
//! Move constructor
ProjectionFiniteStrain(ProjectionFiniteStrain &&other) = default;
//! Destructor
virtual ~ProjectionFiniteStrain() = default;
//! Copy assignment operator
ProjectionFiniteStrain& operator=(const ProjectionFiniteStrain &other) = delete;
//! Move assignment operator
ProjectionFiniteStrain& operator=(ProjectionFiniteStrain &&other) = default;
//! initialises the fft engine (plan the transform)
virtual void initialise(FFT_PlanFlags flags = FFT_PlanFlags::estimate) override final;
protected:
private:
};
} // muSpectre
#endif /* PROJECTION_FINITE_STRAIN_H */
c4science · Help