frequency_system.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2025 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner

// This library 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 2.1 of the License, or (at your option) any later version.

// This library 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
// Lesser General Public License for more details.

// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA



#ifndef LIBMESH_FREQUENCY_SYSTEM_H
#define LIBMESH_FREQUENCY_SYSTEM_H

#include "libmesh/libmesh_config.h"

// Frequency domain solutions only possible with complex arithmetic
#if defined(LIBMESH_USE_COMPLEX_NUMBERS)

// Local Includes
#include "libmesh/linear_implicit_system.h"

// C++ includes
#include <string>
#include <vector>

namespace libMesh
{

class FrequencySystem : public LinearImplicitSystem
{
public:

  FrequencySystem (EquationSystems & es,
                   const std::string & name_in,
                   const unsigned int number_in);
  FrequencySystem (const FrequencySystem &) = delete;
  FrequencySystem & operator= (const FrequencySystem &) = delete;
  FrequencySystem (FrequencySystem &&) = default;
  FrequencySystem & operator= (FrequencySystem &&) = delete;
  virtual ~FrequencySystem ();

  virtual void clear () override;

  void clear_all ();

  virtual void assemble () override;

  virtual void solve () override;

  void solve (const unsigned int n_start,
              const unsigned int n_stop);

  virtual std::string system_type () const override { return "Frequency"; }


  //--------------------------------------------------------
  // Methods specific to the FrequencySystem
  //

  void set_frequencies_by_steps (const Number base_freq,
                                 const Number freq_step=0.,
                                 const unsigned int n_freq=1,
                                 const bool allocate_solution_duplicates=true);

  void set_frequencies_by_range (const Number min_freq,
                                 const Number max_freq,
                                 const unsigned int n_freq,
                                 const bool allocate_solution_duplicates=true);

  void set_frequencies (const std::vector<Real> & frequencies,
                        const bool allocate_solution_duplicates=true);


  void set_frequencies (const std::vector<Number> & frequencies,
                        const bool allocate_solution_duplicates=true);

  unsigned int n_frequencies () const;

  void attach_solve_function(void fptr(EquationSystems & es,
                                       const std::string & name));

  void (* solve_system) (EquationSystems & es,
                         const std::string & name);

  std::pair<unsigned int, Real> get_rval (unsigned int n) const;

  std::string form_freq_param_name(const unsigned int n) const;

  std::string form_solu_vec_name(const unsigned int n) const;


protected:


  virtual void init_data () override;

  void set_current_frequency(unsigned int n);

  bool _finished_set_frequencies;

  bool _keep_solution_duplicates;

  bool _finished_init;

  bool _finished_assemble;

  std::vector<std::pair<unsigned int, Real>> vec_rval;

};



// ------------------------------------------------------------
// FrequencySystem inline methods
inline
std::pair<unsigned int, Real> FrequencySystem::get_rval (unsigned int n) const
{
  libmesh_assert_less (n, vec_rval.size());

  return vec_rval[n];
}


} // namespace libMesh

#endif // if defined(LIBMESH_USE_COMPLEX_NUMBERS)

#endif // LIBMESH_FREQUENCY_SYSTEM_H